mirror of
https://github.com/onyx-and-iris/gobs-cli.git
synced 2026-04-17 22:53:36 +00:00
Compare commits
23 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 6cdc12790a | |||
| 8a5ce67ba0 | |||
| 474693e0f7 | |||
| a960c9ffa5 | |||
| 8ce8727a0a | |||
|
|
fba7c4ce20 | ||
| 1cf983a647 | |||
| dbc26bf6ff | |||
|
|
c5e7bb4e1a | ||
|
|
e087fdefe3 | ||
|
|
bd4a6cad4b | ||
|
|
72fc7d4092 | ||
|
|
cb735cd666 | ||
|
|
db70f8766d | ||
| 101c7552b2 | |||
| 1c0ef025c1 | |||
| 2b7b8e0bd5 | |||
| 040ece840c | |||
| c6406888a9 | |||
| f65af8298d | |||
| 1dfb6f87ac | |||
| 866aedde7c | |||
| 9eb6c8a282 |
12
CHANGELOG.md
12
CHANGELOG.md
@@ -5,6 +5,18 @@ 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.15.0] - 2026-01-26
|
||||
|
||||
### Added
|
||||
|
||||
- new subcommands added to input, see [InputCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#inputcmd)
|
||||
|
||||
# [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
|
||||
|
||||
66
README.md
66
README.md
@@ -77,7 +77,7 @@ gobs-cli --style="red" --no-border sceneitem list
|
||||
Or with environment variables:
|
||||
|
||||
```env
|
||||
GOBS_STYLE=cyan
|
||||
GOBS_STYLE=red
|
||||
GOBS_STYLE_NO_BORDER=true
|
||||
```
|
||||
|
||||
@@ -264,6 +264,20 @@ gobs-cli group status START "test_group"
|
||||
|
||||
### InputCmd
|
||||
|
||||
- create: Create input.
|
||||
- args: Name Kind
|
||||
|
||||
```console
|
||||
gobs-cli input create 'stream mix' 'wasapi_input_capture'
|
||||
```
|
||||
|
||||
- remove: Remove input.
|
||||
- args: Name
|
||||
|
||||
```console
|
||||
gobs-cli input remove 'stream mix'
|
||||
```
|
||||
|
||||
- list: List all inputs.
|
||||
- flags:
|
||||
|
||||
@@ -281,6 +295,12 @@ gobs-cli input list
|
||||
gobs-cli input list --input --colour
|
||||
```
|
||||
|
||||
- list-kinds: List input kinds.
|
||||
|
||||
```console
|
||||
gobs-cli input list-kinds
|
||||
```
|
||||
|
||||
- mute: Mute input.
|
||||
- args: InputName
|
||||
|
||||
@@ -302,6 +322,50 @@ gobs-cli input unmute "Mic/Aux"
|
||||
gobs-cli input toggle "Mic/Aux"
|
||||
```
|
||||
|
||||
- volume: Set input volume.
|
||||
- args: InputName Volume
|
||||
|
||||
```console
|
||||
gobs-cli input volume -- 'Mic/Aux' -30.6
|
||||
```
|
||||
|
||||
- show: Show input details.
|
||||
- args: Name
|
||||
- flags:
|
||||
|
||||
*optional*
|
||||
- --verbose: List all available input devices.
|
||||
|
||||
- update: Update input settings.
|
||||
- args: InputName DeviceName
|
||||
|
||||
```console
|
||||
gobs-cli input update 'Mic/Aux' 'Voicemeeter Out B1 (VB-Audio Voicemeeter VAIO)'
|
||||
```
|
||||
|
||||
- kind-defaults: Get default settings for an input kind.
|
||||
- args: Kind
|
||||
|
||||
```console
|
||||
gobs-cli input kind-defaults 'wasapi_input_capture'
|
||||
```
|
||||
|
||||
### 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.
|
||||
|
||||
@@ -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()
|
||||
|
||||
|
||||
373
input.go
373
input.go
@@ -3,6 +3,7 @@ package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"maps"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
@@ -13,10 +14,63 @@ import (
|
||||
|
||||
// InputCmd provides commands to manage inputs in OBS Studio.
|
||||
type InputCmd struct {
|
||||
List InputListCmd `cmd:"" help:"List all inputs." aliases:"ls"`
|
||||
Mute InputMuteCmd `cmd:"" help:"Mute input." aliases:"m"`
|
||||
Unmute InputUnmuteCmd `cmd:"" help:"Unmute input." aliases:"um"`
|
||||
Toggle InputToggleCmd `cmd:"" help:"Toggle input." aliases:"tg"`
|
||||
Create InputCreateCmd `cmd:"" help:"Create input." aliases:"c"`
|
||||
Remove InputRemoveCmd `cmd:"" help:"Remove input." aliases:"d"`
|
||||
List InputListCmd `cmd:"" help:"List all inputs." aliases:"ls"`
|
||||
ListKinds InputListKindsCmd `cmd:"" help:"List input kinds." aliases:"k"`
|
||||
Mute InputMuteCmd `cmd:"" help:"Mute input." aliases:"m"`
|
||||
Unmute InputUnmuteCmd `cmd:"" help:"Unmute input." aliases:"um"`
|
||||
Toggle InputToggleCmd `cmd:"" help:"Toggle input." aliases:"tg"`
|
||||
Volume InputVolumeCmd `cmd:"" help:"Set input volume." aliases:"v"`
|
||||
Show InputShowCmd `cmd:"" help:"Show input details." aliases:"s"`
|
||||
Update InputUpdateCmd `cmd:"" help:"Update input settings." aliases:"up"`
|
||||
KindDefaults InputKindDefaultsCmd `cmd:"" help:"Get default settings for an input kind." aliases:"df"`
|
||||
}
|
||||
|
||||
// InputCreateCmd provides a command to create an input.
|
||||
type InputCreateCmd struct {
|
||||
Name string `arg:"" help:"Name for the input." required:""`
|
||||
Kind string `arg:"" help:"Input kind (e.g., coreaudio_input_capture, macos-avcapture)." required:""`
|
||||
}
|
||||
|
||||
// Run executes the command to create an input.
|
||||
func (cmd *InputCreateCmd) Run(ctx *context) error {
|
||||
currentScene, err := ctx.Client.Scenes.GetCurrentProgramScene()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
_, err = ctx.Client.Inputs.CreateInput(
|
||||
inputs.NewCreateInputParams().
|
||||
WithInputKind(cmd.Kind).
|
||||
WithInputName(cmd.Name).
|
||||
WithSceneName(currentScene.CurrentProgramSceneName),
|
||||
)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
fmt.Fprintf(ctx.Out, "Created input: %s (%s) in scene %s\n",
|
||||
ctx.Style.Highlight(cmd.Name), cmd.Kind, ctx.Style.Highlight(currentScene.CurrentProgramSceneName))
|
||||
return nil
|
||||
}
|
||||
|
||||
// InputRemoveCmd provides a command to remove an input.
|
||||
type InputRemoveCmd struct {
|
||||
Name string `arg:"" help:"Name of the input to remove." required:""`
|
||||
}
|
||||
|
||||
// Run executes the command to remove an input.
|
||||
func (cmd *InputRemoveCmd) Run(ctx *context) error {
|
||||
_, err := ctx.Client.Inputs.RemoveInput(
|
||||
inputs.NewRemoveInputParams().WithInputName(cmd.Name),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to delete input: %w", err)
|
||||
}
|
||||
|
||||
fmt.Fprintf(ctx.Out, "Deleted %s\n", ctx.Style.Highlight(cmd.Name))
|
||||
return nil
|
||||
}
|
||||
|
||||
// InputListCmd provides a command to list all inputs.
|
||||
@@ -122,6 +176,47 @@ func (cmd *InputListCmd) Run(ctx *context) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// InputListKindsCmd provides a command to list all input kinds.
|
||||
type InputListKindsCmd struct{}
|
||||
|
||||
// Run executes the command to list all input kinds.
|
||||
func (cmd *InputListKindsCmd) Run(ctx *context) error {
|
||||
resp, err := ctx.Client.Inputs.GetInputKindList(
|
||||
inputs.NewGetInputKindListParams().WithUnversioned(false),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get input kinds: %w", err)
|
||||
}
|
||||
|
||||
t := table.New().Border(lipgloss.RoundedBorder()).
|
||||
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
|
||||
t.Headers("Kind")
|
||||
t.StyleFunc(func(row, col int) lipgloss.Style {
|
||||
style := lipgloss.NewStyle().Padding(0, 3)
|
||||
switch col {
|
||||
case 0:
|
||||
style = style.Align(lipgloss.Left)
|
||||
}
|
||||
switch {
|
||||
case row == table.HeaderRow:
|
||||
style = style.Bold(true).Align(lipgloss.Center)
|
||||
case row%2 == 0:
|
||||
style = style.Foreground(ctx.Style.evenRows)
|
||||
default:
|
||||
style = style.Foreground(ctx.Style.oddRows)
|
||||
}
|
||||
return style
|
||||
})
|
||||
|
||||
for _, kind := range resp.InputKinds {
|
||||
t.Row(kind)
|
||||
}
|
||||
|
||||
fmt.Fprintln(ctx.Out, t.Render())
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// InputMuteCmd provides a command to mute an input.
|
||||
type InputMuteCmd struct {
|
||||
InputName string `arg:"" help:"Name of the input to mute."`
|
||||
@@ -188,3 +283,273 @@ func (cmd *InputToggleCmd) Run(ctx *context) error {
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// InputVolumeCmd provides a command to set the volume of an input.
|
||||
type InputVolumeCmd struct {
|
||||
InputName string `arg:"" help:"Name of the input to set volume for." required:""`
|
||||
Volume float64 `arg:"" help:"Volume level (-90.0 to 0.0)." required:""`
|
||||
}
|
||||
|
||||
// Run executes the command to set the volume of an input.
|
||||
// accepts values between -90.0 and 0.0 representing decibels (dB).
|
||||
func (cmd *InputVolumeCmd) Run(ctx *context) error {
|
||||
if cmd.Volume < -90.0 || cmd.Volume > 0.0 {
|
||||
return fmt.Errorf("volume must be between -90.0 and 0.0 dB")
|
||||
}
|
||||
|
||||
_, err := ctx.Client.Inputs.SetInputVolume(
|
||||
inputs.NewSetInputVolumeParams().
|
||||
WithInputName(cmd.InputName).
|
||||
WithInputVolumeDb(cmd.Volume),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to set input volume: %w", err)
|
||||
}
|
||||
|
||||
fmt.Fprintf(ctx.Out, "Set volume of input %s to %.1f dB\n",
|
||||
ctx.Style.Highlight(cmd.InputName), cmd.Volume)
|
||||
return nil
|
||||
}
|
||||
|
||||
// InputShowCmd provides a command to show input details.
|
||||
type InputShowCmd struct {
|
||||
Name string `arg:"" help:"Name of the input to show." required:""`
|
||||
Verbose bool ` help:"List all available input devices." flag:""`
|
||||
}
|
||||
|
||||
// Run executes the command to show input details.
|
||||
func (cmd *InputShowCmd) Run(ctx *context) error {
|
||||
lresp, err := ctx.Client.Inputs.GetInputList(inputs.NewGetInputListParams())
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get input list: %w", err)
|
||||
}
|
||||
|
||||
var inputKind string
|
||||
var found bool
|
||||
for _, input := range lresp.Inputs {
|
||||
if input.InputName == cmd.Name {
|
||||
inputKind = input.InputKind
|
||||
found = true
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if !found {
|
||||
return fmt.Errorf("input '%s' not found", cmd.Name)
|
||||
}
|
||||
|
||||
prop, name := device(ctx, cmd.Name)
|
||||
if prop == "" {
|
||||
return fmt.Errorf("no device property found for input '%s'", cmd.Name)
|
||||
}
|
||||
|
||||
t := table.New().Border(lipgloss.RoundedBorder()).
|
||||
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
|
||||
t.Headers("Input Name", "Kind", "Device")
|
||||
t.StyleFunc(func(row, col int) lipgloss.Style {
|
||||
style := lipgloss.NewStyle().Padding(0, 3)
|
||||
switch col {
|
||||
case 0:
|
||||
style = style.Align(lipgloss.Left)
|
||||
case 1:
|
||||
style = style.Align(lipgloss.Left)
|
||||
case 2:
|
||||
style = style.Align(lipgloss.Center)
|
||||
}
|
||||
switch {
|
||||
case row == table.HeaderRow:
|
||||
style = style.Bold(true).Align(lipgloss.Center)
|
||||
case row%2 == 0:
|
||||
style = style.Foreground(ctx.Style.evenRows)
|
||||
default:
|
||||
style = style.Foreground(ctx.Style.oddRows)
|
||||
}
|
||||
return style
|
||||
})
|
||||
t.Row(cmd.Name, snakeCaseToTitleCase(inputKind), name)
|
||||
|
||||
fmt.Fprintln(ctx.Out, t.Render())
|
||||
|
||||
if cmd.Verbose {
|
||||
deviceListResp, err := ctx.Client.Inputs.GetInputPropertiesListPropertyItems(
|
||||
inputs.NewGetInputPropertiesListPropertyItemsParams().
|
||||
WithInputName(cmd.Name).
|
||||
WithPropertyName(prop),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get device list: %w", err)
|
||||
}
|
||||
|
||||
t := table.New().Border(lipgloss.RoundedBorder()).
|
||||
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
|
||||
t.StyleFunc(func(row, col int) lipgloss.Style {
|
||||
style := lipgloss.NewStyle().Padding(0, 3)
|
||||
switch col {
|
||||
case 0:
|
||||
style = style.Align(lipgloss.Left)
|
||||
}
|
||||
switch {
|
||||
case row == table.HeaderRow:
|
||||
style = style.Bold(true).Align(lipgloss.Center)
|
||||
case row%2 == 0:
|
||||
style = style.Foreground(ctx.Style.evenRows)
|
||||
default:
|
||||
style = style.Foreground(ctx.Style.oddRows)
|
||||
}
|
||||
return style
|
||||
})
|
||||
|
||||
t.Headers("Devices")
|
||||
|
||||
for _, item := range deviceListResp.PropertyItems {
|
||||
if item.ItemName != "" {
|
||||
t.Row(item.ItemName)
|
||||
}
|
||||
}
|
||||
|
||||
fmt.Fprintln(ctx.Out, t.Render())
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func device(ctx *context, inputName string) (string, string) {
|
||||
settings, err := ctx.Client.Inputs.GetInputSettings(
|
||||
inputs.NewGetInputSettingsParams().WithInputName(inputName),
|
||||
)
|
||||
if err != nil {
|
||||
return "", ""
|
||||
}
|
||||
|
||||
for _, propName := range []string{"device", "device_id"} {
|
||||
deviceListResp, err := ctx.Client.Inputs.GetInputPropertiesListPropertyItems(
|
||||
inputs.NewGetInputPropertiesListPropertyItemsParams().
|
||||
WithInputName(inputName).
|
||||
WithPropertyName(propName),
|
||||
)
|
||||
if err == nil && len(deviceListResp.PropertyItems) > 0 {
|
||||
for _, item := range deviceListResp.PropertyItems {
|
||||
if item.ItemValue == settings.InputSettings[propName] {
|
||||
return propName, item.ItemName
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return "", ""
|
||||
}
|
||||
|
||||
// InputUpdateCmd provides a command to update input settings.
|
||||
type InputUpdateCmd struct {
|
||||
InputName string `arg:"" help:"Name of the input to update." required:""`
|
||||
DeviceName string `arg:"" help:"Name of the device to set." required:""`
|
||||
}
|
||||
|
||||
// Run executes the command to update input settings.
|
||||
func (cmd *InputUpdateCmd) Run(ctx *context) error {
|
||||
// Use the device helper to find the correct device property name
|
||||
prop, _ := device(ctx, cmd.InputName)
|
||||
if prop == "" {
|
||||
return fmt.Errorf("no device property found for input '%s'", cmd.InputName)
|
||||
}
|
||||
|
||||
resp, err := ctx.Client.Inputs.GetInputPropertiesListPropertyItems(
|
||||
inputs.NewGetInputPropertiesListPropertyItemsParams().
|
||||
WithInputName(cmd.InputName).
|
||||
WithPropertyName(prop),
|
||||
)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
var deviceValue any
|
||||
var found bool
|
||||
for _, item := range resp.PropertyItems {
|
||||
if item.ItemName == cmd.DeviceName {
|
||||
deviceValue = item.ItemValue
|
||||
found = true
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if !found {
|
||||
return fmt.Errorf("device '%s' not found for input '%s'", cmd.DeviceName, cmd.InputName)
|
||||
}
|
||||
|
||||
sresp, err := ctx.Client.Inputs.GetInputSettings(
|
||||
inputs.NewGetInputSettingsParams().WithInputName(cmd.InputName),
|
||||
)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
settings := make(map[string]any)
|
||||
maps.Copy(settings, sresp.InputSettings)
|
||||
settings[prop] = deviceValue
|
||||
|
||||
_, err = ctx.Client.Inputs.SetInputSettings(
|
||||
inputs.NewSetInputSettingsParams().
|
||||
WithInputName(cmd.InputName).
|
||||
WithInputSettings(settings),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to update input settings: %w", err)
|
||||
}
|
||||
|
||||
fmt.Fprintf(ctx.Out, "Input %s %s set to %s\n",
|
||||
ctx.Style.Highlight(cmd.InputName), prop, ctx.Style.Highlight(cmd.DeviceName))
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// InputKindDefaultsCmd provides a command to get default settings for an input kind.
|
||||
type InputKindDefaultsCmd struct {
|
||||
Kind string `arg:"" help:"Input kind to get default settings for." required:""`
|
||||
}
|
||||
|
||||
// Run executes the command to get default settings for an input kind.
|
||||
func (cmd *InputKindDefaultsCmd) Run(ctx *context) error {
|
||||
resp, err := ctx.Client.Inputs.GetInputDefaultSettings(
|
||||
inputs.NewGetInputDefaultSettingsParams().
|
||||
WithInputKind(cmd.Kind),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get default settings for input kind '%s': %w", cmd.Kind, err)
|
||||
}
|
||||
|
||||
t := table.New().Border(lipgloss.RoundedBorder()).
|
||||
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
|
||||
t.Headers("Setting", "Value")
|
||||
t.StyleFunc(func(row, col int) lipgloss.Style {
|
||||
style := lipgloss.NewStyle().Padding(0, 3)
|
||||
switch col {
|
||||
case 0:
|
||||
style = style.Align(lipgloss.Left)
|
||||
case 1:
|
||||
style = style.Align(lipgloss.Center)
|
||||
}
|
||||
switch {
|
||||
case row == table.HeaderRow:
|
||||
style = style.Bold(true).Align(lipgloss.Center)
|
||||
case row%2 == 0:
|
||||
style = style.Foreground(ctx.Style.evenRows)
|
||||
default:
|
||||
style = style.Foreground(ctx.Style.oddRows)
|
||||
}
|
||||
return style
|
||||
})
|
||||
|
||||
keys := make([]string, 0, len(resp.DefaultInputSettings))
|
||||
for k := range resp.DefaultInputSettings {
|
||||
keys = append(keys, k)
|
||||
}
|
||||
sort.Strings(keys)
|
||||
|
||||
for _, key := range keys {
|
||||
value := resp.DefaultInputSettings[key]
|
||||
t.Row(key, fmt.Sprintf("%v", value))
|
||||
}
|
||||
|
||||
fmt.Fprintln(ctx.Out, t.Render())
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -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) {
|
||||
|
||||
1
main.go
1
main.go
@@ -59,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"`
|
||||
|
||||
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()
|
||||
|
||||
@@ -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())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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
|
||||
}
|
||||
Reference in New Issue
Block a user