mirror of
https://github.com/onyx-and-iris/gobs-cli.git
synced 2025-06-10 05:30:34 +01:00
Compare commits
23 Commits
Author | SHA1 | Date | |
---|---|---|---|
d9c0e40d8f | |||
42ab45b9fb | |||
27c3c5369b | |||
0a0c75ae51 | |||
cf5da68137 | |||
14d9feb43e | |||
8204d6520d | |||
1d590eb788 | |||
29fe6fedfb | |||
ee47832cd6 | |||
17b8e53da3 | |||
92761ab1b3 | |||
4446784709 | |||
89a5add7ad | |||
878ecbd33e | |||
18a90e727f | |||
95ebb2afb6 | |||
666b4cf744 | |||
9ee6fa9e34 | |||
e5223fbdfd | |||
c22ab4384d | |||
93a3d3e49f | |||
2228574837 |
43
CHANGELOG.md
43
CHANGELOG.md
@ -5,6 +5,49 @@ 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.10.3] - 2025-06-07
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- filter list:
|
||||||
|
- --ffmpeg, --vlc flags
|
||||||
|
- Muted column to list table
|
||||||
|
|
||||||
|
# [0.10.2] - 2025-06-04
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- screenshot save command, see [ScreenshotCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#screenshotcmd)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- filter list:
|
||||||
|
- sourceName arg now defaults to current scene.
|
||||||
|
- defaults are printed for any unmodified values.
|
||||||
|
- sceneitem list:
|
||||||
|
- prints enabled mark instead of true/false
|
||||||
|
|
||||||
|
# [0.9.0] - 2025-06-02
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- --version/-v option. See [Flags](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#flags)
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- version command renamed to obs-version
|
||||||
|
|
||||||
|
# [0.8.2] - 2025-05-29
|
||||||
|
|
||||||
|
### 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
|
# [0.8.0] - 2025-05-27
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
59
README.md
59
README.md
@ -14,10 +14,16 @@ go install github.com/onyx-and-iris/gobs-cli@latest
|
|||||||
|
|
||||||
#### Flags
|
#### Flags
|
||||||
|
|
||||||
Pass `--host`, `--port` and `--password` as flags to the root command, for example:
|
- --host/-H: Websocket host
|
||||||
|
- --port/-P Websocket port
|
||||||
|
- --password/-p: Websocket password
|
||||||
|
- --timeout/-T: Websocket timeout
|
||||||
|
- --version/-v: Print the gobs-cli version
|
||||||
|
|
||||||
|
Pass `--host`, `--port` and `--password` as flags on the root command, for example:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
gobs-cli --host=localhost --port=4455 --password=<websocket password> --help
|
gobs-cli --host localhost --port 4455 --password 'websocket password' --help
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Environment Variables
|
#### Environment Variables
|
||||||
@ -37,10 +43,12 @@ OBS_TIMEOUT=5
|
|||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
### VersionCmd
|
### ObsVersionCmd
|
||||||
|
|
||||||
|
- Print OBS client and websocket version.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
gobs-cli version
|
gobs-cli obs-version
|
||||||
```
|
```
|
||||||
|
|
||||||
### SceneCmd
|
### SceneCmd
|
||||||
@ -94,7 +102,7 @@ gobs-cli sceneitem list LIVE
|
|||||||
- flags:
|
- flags:
|
||||||
|
|
||||||
*optional*
|
*optional*
|
||||||
- --parent: Parent group name.
|
- --group: Parent group name.
|
||||||
- args: SceneName ItemName
|
- args: SceneName ItemName
|
||||||
|
|
||||||
```console
|
```console
|
||||||
@ -105,7 +113,7 @@ gobs-cli sceneitem show START "Colour Source"
|
|||||||
- flags:
|
- flags:
|
||||||
|
|
||||||
*optional*
|
*optional*
|
||||||
- --parent: Parent group name.
|
- --group: Parent group name.
|
||||||
- args: SceneName ItemName
|
- args: SceneName ItemName
|
||||||
|
|
||||||
```console
|
```console
|
||||||
@ -116,29 +124,29 @@ gobs-cli sceneitem hide START "Colour Source"
|
|||||||
- flags:
|
- flags:
|
||||||
|
|
||||||
*optional*
|
*optional*
|
||||||
- --parent: Parent group name.
|
- --group: Parent group name.
|
||||||
- args: SceneName ItemName
|
- args: SceneName ItemName
|
||||||
|
|
||||||
```console
|
```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.
|
- visible: Get scene item visibility.
|
||||||
- flags:
|
- flags:
|
||||||
|
|
||||||
*optional*
|
*optional*
|
||||||
- --parent: Parent group name.
|
- --group: Parent group name.
|
||||||
- args: SceneName ItemName
|
- args: SceneName ItemName
|
||||||
|
|
||||||
```console
|
```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.
|
- transform: Transform scene item.
|
||||||
- flags:
|
- flags:
|
||||||
|
|
||||||
*optional*
|
*optional*
|
||||||
- --parent: Parent group name.
|
- --group: Parent group name.
|
||||||
|
|
||||||
- --alignment: Alignment of the scene item.
|
- --alignment: Alignment of the scene item.
|
||||||
- --bounds-alignment: Bounds alignment of the scene item.
|
- --bounds-alignment: Bounds alignment of the scene item.
|
||||||
@ -215,6 +223,8 @@ gobs-cli group status START "test_group"
|
|||||||
- --input: List all inputs.
|
- --input: List all inputs.
|
||||||
- --output: List all outputs.
|
- --output: List all outputs.
|
||||||
- --colour: List all colour sources.
|
- --colour: List all colour sources.
|
||||||
|
- --ffmpeg: List all ffmpeg sources.
|
||||||
|
- --vlc: List all VLC sources.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
gobs-cli input list
|
gobs-cli input list
|
||||||
@ -505,6 +515,10 @@ gobs-cli hotkey trigger-sequence OBS_KEY_F1 --shift --ctrl
|
|||||||
|
|
||||||
- list: List all filters.
|
- list: List all filters.
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- args: SourceName
|
||||||
|
- defaults to current scene
|
||||||
|
|
||||||
```console
|
```console
|
||||||
gobs-cli filter list
|
gobs-cli filter list
|
||||||
```
|
```
|
||||||
@ -553,17 +567,36 @@ gobs-cli projector list-monitors
|
|||||||
- defaults to 0
|
- defaults to 0
|
||||||
|
|
||||||
*optional*
|
*optional*
|
||||||
- args: <source_name>
|
- args: SourceName
|
||||||
- defaults to current scene
|
- defaults to current scene
|
||||||
|
|
||||||
```console
|
```console
|
||||||
gobs-cli project open
|
gobs-cli projector open
|
||||||
|
|
||||||
gobs-cli projector open --monitor-index=1 "test_scene"
|
gobs-cli projector open --monitor-index=1 "test_scene"
|
||||||
|
|
||||||
gobs-cli projector open --monitor-index=1 "test_group"
|
gobs-cli projector open --monitor-index=1 "test_group"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### ScreenshotCmd
|
||||||
|
|
||||||
|
- save: Take a screenshot and save it to a file.
|
||||||
|
- flags:
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- --width:
|
||||||
|
- defaults to 1920
|
||||||
|
- --height:
|
||||||
|
- defaults to 1080
|
||||||
|
- --quality:
|
||||||
|
- defaults to -1
|
||||||
|
|
||||||
|
- args: SourceName FilePath
|
||||||
|
|
||||||
|
```console
|
||||||
|
gobs-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png"
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
[userconfigdir]: https://pkg.go.dev/os#UserConfigDir
|
[userconfigdir]: https://pkg.go.dev/os#UserConfigDir
|
||||||
[obs-keyids]: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h
|
[obs-keyids]: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h
|
@ -7,6 +7,8 @@ vars:
|
|||||||
PROGRAM: gobs-cli
|
PROGRAM: gobs-cli
|
||||||
SHELL: '{{if eq .OS "Windows_NT"}}powershell{{end}}'
|
SHELL: '{{if eq .OS "Windows_NT"}}powershell{{end}}'
|
||||||
BIN_DIR: bin
|
BIN_DIR: bin
|
||||||
|
VERSION:
|
||||||
|
sh: 'git describe --tags $(git rev-list --tags --max-count=1)'
|
||||||
|
|
||||||
tasks:
|
tasks:
|
||||||
default:
|
default:
|
||||||
@ -35,13 +37,13 @@ tasks:
|
|||||||
build-windows:
|
build-windows:
|
||||||
desc: Build the gobs-cli project for Windows
|
desc: Build the gobs-cli project for Windows
|
||||||
cmds:
|
cmds:
|
||||||
- GOOS=windows GOARCH=amd64 go build -o {{.BIN_DIR}}/{{.PROGRAM}}_windows_amd64.exe
|
- GOOS=windows GOARCH=amd64 go build -ldflags "-X 'main.version={{.VERSION}}'" -o {{.BIN_DIR}}/{{.PROGRAM}}_windows_amd64.exe
|
||||||
internal: true
|
internal: true
|
||||||
|
|
||||||
build-linux:
|
build-linux:
|
||||||
desc: Build the gobs-cli project for Linux
|
desc: Build the gobs-cli project for Linux
|
||||||
cmds:
|
cmds:
|
||||||
- GOOS=linux GOARCH=amd64 go build -o {{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64
|
- GOOS=linux GOARCH=amd64 go build -ldflags "-X 'main.version={{.VERSION}}'" -o {{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64
|
||||||
internal: true
|
internal: true
|
||||||
|
|
||||||
test:
|
test:
|
||||||
|
31
filter.go
31
filter.go
@ -2,6 +2,7 @@ package main
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"maps"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
@ -20,19 +21,27 @@ type FilterCmd struct {
|
|||||||
|
|
||||||
// FilterListCmd provides a command to list all filters in a scene.
|
// FilterListCmd provides a command to list all filters in a scene.
|
||||||
type FilterListCmd struct {
|
type FilterListCmd struct {
|
||||||
SourceName string `arg:"" help:"Name of the source to list filters from."`
|
SourceName string `arg:"" help:"Name of the source to list filters from." default:""`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Run executes the command to list all filters in a scene.
|
// Run executes the command to list all filters in a scene.
|
||||||
func (cmd *FilterListCmd) Run(ctx *context) error {
|
func (cmd *FilterListCmd) Run(ctx *context) error {
|
||||||
filters, err := ctx.Client.Filters.GetSourceFilterList(
|
if cmd.SourceName == "" {
|
||||||
|
currentScene, err := ctx.Client.Scenes.GetCurrentProgramScene()
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to get current program scene: %w", err)
|
||||||
|
}
|
||||||
|
cmd.SourceName = currentScene.SceneName
|
||||||
|
}
|
||||||
|
|
||||||
|
sourceFilters, err := ctx.Client.Filters.GetSourceFilterList(
|
||||||
filters.NewGetSourceFilterListParams().WithSourceName(cmd.SourceName),
|
filters.NewGetSourceFilterListParams().WithSourceName(cmd.SourceName),
|
||||||
)
|
)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(filters.Filters) == 0 {
|
if len(sourceFilters.Filters) == 0 {
|
||||||
fmt.Fprintf(ctx.Out, "No filters found for source %s.\n", cmd.SourceName)
|
fmt.Fprintf(ctx.Out, "No filters found for source %s.\n", cmd.SourceName)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@ -42,10 +51,20 @@ func (cmd *FilterListCmd) Run(ctx *context) error {
|
|||||||
t.SetAlignment(table.AlignLeft, table.AlignLeft, table.AlignCenter, table.AlignLeft)
|
t.SetAlignment(table.AlignLeft, table.AlignLeft, table.AlignCenter, table.AlignLeft)
|
||||||
t.SetHeaders("Filter Name", "Kind", "Enabled", "Settings")
|
t.SetHeaders("Filter Name", "Kind", "Enabled", "Settings")
|
||||||
|
|
||||||
for _, filter := range filters.Filters {
|
for _, filter := range sourceFilters.Filters {
|
||||||
|
defaultSettings, err := ctx.Client.Filters.GetSourceFilterDefaultSettings(
|
||||||
|
filters.NewGetSourceFilterDefaultSettingsParams().
|
||||||
|
WithFilterKind(filter.FilterKind),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to get default settings for filter %s: %w",
|
||||||
|
filter.FilterName, err)
|
||||||
|
}
|
||||||
|
maps.Insert(defaultSettings.DefaultFilterSettings, maps.All(filter.FilterSettings))
|
||||||
|
|
||||||
var lines []string
|
var lines []string
|
||||||
for k, v := range filter.FilterSettings {
|
for k, v := range defaultSettings.DefaultFilterSettings {
|
||||||
lines = append(lines, fmt.Sprintf("%s %v", k, v))
|
lines = append(lines, fmt.Sprintf("%s: %v", snakeCaseToTitleCase(k), v))
|
||||||
}
|
}
|
||||||
sort.Slice(lines, func(i, j int) bool {
|
sort.Slice(lines, func(i, j int) bool {
|
||||||
return strings.ToLower(lines[i]) < strings.ToLower(lines[j])
|
return strings.ToLower(lines[i]) < strings.ToLower(lines[j])
|
||||||
|
51
input.go
51
input.go
@ -21,6 +21,8 @@ type InputListCmd struct {
|
|||||||
Input bool `flag:"" help:"List all inputs." aliases:"i"`
|
Input bool `flag:"" help:"List all inputs." aliases:"i"`
|
||||||
Output bool `flag:"" help:"List all outputs." aliases:"o"`
|
Output bool `flag:"" help:"List all outputs." aliases:"o"`
|
||||||
Colour bool `flag:"" help:"List all colour sources." aliases:"c"`
|
Colour bool `flag:"" help:"List all colour sources." aliases:"c"`
|
||||||
|
Ffmpeg bool `flag:"" help:"List all ffmpeg sources." aliases:"f"`
|
||||||
|
Vlc bool `flag:"" help:"List all VLC sources." aliases:"v"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Run executes the command to list all inputs.
|
// Run executes the command to list all inputs.
|
||||||
@ -32,22 +34,47 @@ func (cmd *InputListCmd) Run(ctx *context) error {
|
|||||||
|
|
||||||
t := table.New(ctx.Out)
|
t := table.New(ctx.Out)
|
||||||
t.SetPadding(3)
|
t.SetPadding(3)
|
||||||
t.SetAlignment(table.AlignLeft, table.AlignLeft)
|
t.SetAlignment(table.AlignLeft, table.AlignLeft, table.AlignCenter)
|
||||||
t.SetHeaders("Input Name", "Kind")
|
t.SetHeaders("Input Name", "Kind", "Muted")
|
||||||
|
|
||||||
for _, input := range resp.Inputs {
|
for _, input := range resp.Inputs {
|
||||||
if cmd.Input && strings.Contains(input.InputKind, "input") {
|
var muteMark string
|
||||||
t.AddRow(input.InputName, input.InputKind)
|
for _, kind := range []string{"input", "output", "ffmpeg", "vlc"} {
|
||||||
}
|
if strings.Contains(input.InputKind, kind) {
|
||||||
if cmd.Output && strings.Contains(input.InputKind, "output") {
|
resp, err := ctx.Client.Inputs.GetInputMute(
|
||||||
t.AddRow(input.InputName, input.InputKind)
|
inputs.NewGetInputMuteParams().WithInputName(input.InputName),
|
||||||
}
|
)
|
||||||
if cmd.Colour && strings.Contains(input.InputKind, "color") { // nolint
|
if err != nil {
|
||||||
t.AddRow(input.InputName, input.InputKind)
|
return fmt.Errorf("failed to get input mute state: %w", err)
|
||||||
|
}
|
||||||
|
muteMark = getEnabledMark(resp.InputMuted)
|
||||||
|
break
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if !cmd.Input && !cmd.Output && !cmd.Colour {
|
type filter struct {
|
||||||
t.AddRow(input.InputName, input.InputKind)
|
enabled bool
|
||||||
|
keyword string
|
||||||
|
}
|
||||||
|
filters := []filter{
|
||||||
|
{cmd.Input, "input"},
|
||||||
|
{cmd.Output, "output"},
|
||||||
|
{cmd.Colour, "color"}, // nolint: misspell
|
||||||
|
{cmd.Ffmpeg, "ffmpeg"},
|
||||||
|
{cmd.Vlc, "vlc"},
|
||||||
|
}
|
||||||
|
|
||||||
|
var added bool
|
||||||
|
for _, f := range filters {
|
||||||
|
if f.enabled && strings.Contains(input.InputKind, f.keyword) {
|
||||||
|
t.AddRow(input.InputName, input.InputKind, muteMark)
|
||||||
|
added = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if !added && (!cmd.Input && !cmd.Output && !cmd.Colour && !cmd.Ffmpeg && !cmd.Vlc) {
|
||||||
|
t.AddRow(input.InputName, input.InputKind, muteMark)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
t.Render()
|
t.Render()
|
||||||
|
42
main.go
42
main.go
@ -18,10 +18,10 @@ import (
|
|||||||
|
|
||||||
// ObsConfig holds the configuration for connecting to the OBS WebSocket server.
|
// ObsConfig holds the configuration for connecting to the OBS WebSocket server.
|
||||||
type ObsConfig struct {
|
type ObsConfig struct {
|
||||||
Host string `flag:"host" help:"Host to connect to." default:"localhost" env:"OBS_HOST"`
|
Host string `flag:"host" help:"Host to connect to." default:"localhost" env:"OBS_HOST" short:"H"`
|
||||||
Port int `flag:"port" help:"Port to connect to." default:"4455" env:"OBS_PORT"`
|
Port int `flag:"port" help:"Port to connect to." default:"4455" env:"OBS_PORT" short:"P"`
|
||||||
Password string `flag:"password" help:"Password for authentication." default:"" env:"OBS_PASSWORD"`
|
Password string `flag:"password" help:"Password for authentication." default:"" env:"OBS_PASSWORD" short:"p"`
|
||||||
Timeout int `flag:"timeout" help:"Timeout in seconds." default:"5" env:"OBS_TIMEOUT"`
|
Timeout int `flag:"timeout" help:"Timeout in seconds." default:"5" env:"OBS_TIMEOUT" short:"T"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// CLI is the main command line interface structure.
|
// CLI is the main command line interface structure.
|
||||||
@ -29,23 +29,25 @@ type ObsConfig struct {
|
|||||||
type CLI struct {
|
type CLI struct {
|
||||||
ObsConfig `embed:"" help:"OBS WebSocket configuration."`
|
ObsConfig `embed:"" help:"OBS WebSocket configuration."`
|
||||||
|
|
||||||
Man mangokong.ManFlag `help:"Print man page."`
|
Man mangokong.ManFlag `help:"Print man page."`
|
||||||
|
Version VersionFlag `help:"Print gobs-cli version information and quit" name:"version" short:"v"`
|
||||||
|
|
||||||
Version VersionCmd `help:"Show version." cmd:"" aliases:"v"`
|
ObsVersion ObsVersionCmd `help:"Print OBS client and websocket version." cmd:"" aliases:"v"`
|
||||||
Scene SceneCmd `help:"Manage scenes." cmd:"" aliases:"sc"`
|
Scene SceneCmd `help:"Manage scenes." cmd:"" aliases:"sc"`
|
||||||
Sceneitem SceneItemCmd `help:"Manage scene items." cmd:"" aliases:"si"`
|
Sceneitem SceneItemCmd `help:"Manage scene items." cmd:"" aliases:"si"`
|
||||||
Group GroupCmd `help:"Manage groups." cmd:"" aliases:"g"`
|
Group GroupCmd `help:"Manage groups." cmd:"" aliases:"g"`
|
||||||
Input InputCmd `help:"Manage inputs." cmd:"" aliases:"i"`
|
Input InputCmd `help:"Manage inputs." cmd:"" aliases:"i"`
|
||||||
Record RecordCmd `help:"Manage recording." cmd:"" aliases:"rec"`
|
Record RecordCmd `help:"Manage recording." cmd:"" aliases:"rec"`
|
||||||
Stream StreamCmd `help:"Manage streaming." cmd:"" aliases:"st"`
|
Stream StreamCmd `help:"Manage streaming." cmd:"" aliases:"st"`
|
||||||
Scenecollection SceneCollectionCmd `help:"Manage scene collections." cmd:"" aliases:"scn"`
|
Scenecollection SceneCollectionCmd `help:"Manage scene collections." cmd:"" aliases:"scn"`
|
||||||
Profile ProfileCmd `help:"Manage profiles." cmd:"" aliases:"p"`
|
Profile ProfileCmd `help:"Manage profiles." cmd:"" aliases:"p"`
|
||||||
Replaybuffer ReplayBufferCmd `help:"Manage replay buffer." cmd:"" aliases:"rb"`
|
Replaybuffer ReplayBufferCmd `help:"Manage replay buffer." cmd:"" aliases:"rb"`
|
||||||
Studiomode StudioModeCmd `help:"Manage studio mode." cmd:"" aliases:"sm"`
|
Studiomode StudioModeCmd `help:"Manage studio mode." cmd:"" aliases:"sm"`
|
||||||
Virtualcam VirtualCamCmd `help:"Manage virtual camera." cmd:"" aliases:"vc"`
|
Virtualcam VirtualCamCmd `help:"Manage virtual camera." cmd:"" aliases:"vc"`
|
||||||
Hotkey HotkeyCmd `help:"Manage hotkeys." cmd:"" aliases:"hk"`
|
Hotkey HotkeyCmd `help:"Manage hotkeys." cmd:"" aliases:"hk"`
|
||||||
Filter FilterCmd `help:"Manage filters." cmd:"" aliases:"f"`
|
Filter FilterCmd `help:"Manage filters." cmd:"" aliases:"f"`
|
||||||
Projector ProjectorCmd `help:"Manage projectors." cmd:"" aliases:"prj"`
|
Projector ProjectorCmd `help:"Manage projectors." cmd:"" aliases:"prj"`
|
||||||
|
Screenshot ScreenshotCmd `help:"Take screenshots." cmd:"" aliases:"ss"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type context struct {
|
type context struct {
|
||||||
|
@ -35,8 +35,8 @@ func TestRecordStart(t *testing.T) {
|
|||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatalf("Expected error when starting recording while active, got nil")
|
t.Fatalf("Expected error when starting recording while active, got nil")
|
||||||
}
|
}
|
||||||
if !strings.Contains(err.Error(), "Recording is already in progress") {
|
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())
|
t.Fatalf("Expected error message to contain 'recording is already in progress', got '%s'", err.Error())
|
||||||
}
|
}
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
73
sceneitem.go
73
sceneitem.go
@ -2,6 +2,7 @@ package main
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"sort"
|
||||||
|
|
||||||
"github.com/andreykaipov/goobs"
|
"github.com/andreykaipov/goobs"
|
||||||
"github.com/andreykaipov/goobs/api/requests/sceneitems"
|
"github.com/andreykaipov/goobs/api/requests/sceneitems"
|
||||||
@ -46,31 +47,57 @@ func (cmd *SceneItemListCmd) Run(ctx *context) error {
|
|||||||
|
|
||||||
t := table.New(ctx.Out)
|
t := table.New(ctx.Out)
|
||||||
t.SetPadding(3)
|
t.SetPadding(3)
|
||||||
t.SetAlignment(table.AlignLeft)
|
t.SetAlignment(table.AlignCenter, table.AlignLeft, table.AlignCenter, table.AlignCenter)
|
||||||
t.SetHeaders("Item Name")
|
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 {
|
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,
|
||||||
|
getEnabledMark(item.SceneItemEnabled && groupItem.SceneItemEnabled),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
t.AddRow(fmt.Sprintf("%d", item.SceneItemID), item.SourceName, "", getEnabledMark(item.SceneItemEnabled))
|
||||||
|
}
|
||||||
}
|
}
|
||||||
t.Render()
|
t.Render()
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// getSceneNameAndItemID retrieves the scene name and item ID for a given item in a scene or group.
|
||||||
func getSceneNameAndItemID(
|
func getSceneNameAndItemID(
|
||||||
client *goobs.Client,
|
client *goobs.Client,
|
||||||
sceneName string,
|
sceneName string,
|
||||||
itemName string,
|
itemName string,
|
||||||
parent string,
|
group string,
|
||||||
) (string, int, error) {
|
) (string, int, error) {
|
||||||
if parent != "" {
|
if group != "" {
|
||||||
resp, err := client.SceneItems.GetGroupSceneItemList(sceneitems.NewGetGroupSceneItemListParams().
|
resp, err := client.SceneItems.GetGroupSceneItemList(sceneitems.NewGetGroupSceneItemListParams().
|
||||||
WithSceneName(parent))
|
WithSceneName(group))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", 0, err
|
return "", 0, err
|
||||||
}
|
}
|
||||||
for _, item := range resp.SceneItems {
|
for _, item := range resp.SceneItems {
|
||||||
if item.SourceName == itemName {
|
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)
|
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.
|
// SceneItemShowCmd provides a command to show a scene item.
|
||||||
type SceneItemShowCmd struct {
|
type SceneItemShowCmd struct {
|
||||||
Parent string `flag:"" help:"Parent group name."`
|
Group string `flag:"" help:"Parent group name."`
|
||||||
|
|
||||||
SceneName string `arg:"" help:"Scene name."`
|
SceneName string `arg:"" help:"Scene name."`
|
||||||
ItemName string `arg:"" help:"Item name."`
|
ItemName string `arg:"" help:"Item name."`
|
||||||
@ -95,7 +122,7 @@ type SceneItemShowCmd struct {
|
|||||||
|
|
||||||
// Run executes the command to show a scene item.
|
// Run executes the command to show a scene item.
|
||||||
func (cmd *SceneItemShowCmd) Run(ctx *context) error {
|
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 {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@ -108,8 +135,8 @@ func (cmd *SceneItemShowCmd) Run(ctx *context) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
if cmd.Parent != "" {
|
if cmd.Group != "" {
|
||||||
fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now visible.\n", cmd.ItemName, cmd.Parent)
|
fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now visible.\n", cmd.ItemName, cmd.Group)
|
||||||
} else {
|
} else {
|
||||||
fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' is now visible.\n", cmd.ItemName, cmd.SceneName)
|
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.
|
// SceneItemHideCmd provides a command to hide a scene item.
|
||||||
type SceneItemHideCmd struct {
|
type SceneItemHideCmd struct {
|
||||||
Parent string `flag:"" help:"Parent group name."`
|
Group string `flag:"" help:"Parent group name."`
|
||||||
|
|
||||||
SceneName string `arg:"" help:"Scene name."`
|
SceneName string `arg:"" help:"Scene name."`
|
||||||
ItemName string `arg:"" help:"Item name."`
|
ItemName string `arg:"" help:"Item name."`
|
||||||
@ -127,7 +154,7 @@ type SceneItemHideCmd struct {
|
|||||||
|
|
||||||
// Run executes the command to hide a scene item.
|
// Run executes the command to hide a scene item.
|
||||||
func (cmd *SceneItemHideCmd) Run(ctx *context) error {
|
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 {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@ -140,8 +167,8 @@ func (cmd *SceneItemHideCmd) Run(ctx *context) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
if cmd.Parent != "" {
|
if cmd.Group != "" {
|
||||||
fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now hidden.\n", cmd.ItemName, cmd.Parent)
|
fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' is now hidden.\n", cmd.ItemName, cmd.Group)
|
||||||
} else {
|
} else {
|
||||||
fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' is now hidden.\n", cmd.ItemName, cmd.SceneName)
|
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.
|
// SceneItemToggleCmd provides a command to toggle the visibility of a scene item.
|
||||||
type SceneItemToggleCmd struct {
|
type SceneItemToggleCmd struct {
|
||||||
Parent string `flag:"" help:"Parent group name."`
|
Group string `flag:"" help:"Parent group name."`
|
||||||
|
|
||||||
SceneName string `arg:"" help:"Scene name."`
|
SceneName string `arg:"" help:"Scene name."`
|
||||||
ItemName string `arg:"" help:"Item 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.
|
// Run executes the command to toggle the visibility of a scene item.
|
||||||
func (cmd *SceneItemToggleCmd) Run(ctx *context) error {
|
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 {
|
if err != nil {
|
||||||
return err
|
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.
|
// SceneItemVisibleCmd provides a command to check the visibility of a scene item.
|
||||||
type SceneItemVisibleCmd struct {
|
type SceneItemVisibleCmd struct {
|
||||||
Parent string `flag:"" help:"Parent group name."`
|
Group string `flag:"" help:"Parent group name."`
|
||||||
|
|
||||||
SceneName string `arg:"" help:"Scene name."`
|
SceneName string `arg:"" help:"Scene name."`
|
||||||
ItemName string `arg:"" help:"Item 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.
|
// Run executes the command to check the visibility of a scene item.
|
||||||
func (cmd *SceneItemVisibleCmd) Run(ctx *context) error {
|
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 {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@ -230,7 +257,7 @@ type SceneItemTransformCmd struct {
|
|||||||
SceneName string `arg:"" help:"Scene name."`
|
SceneName string `arg:"" help:"Scene name."`
|
||||||
ItemName string `arg:"" help:"Item 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."`
|
Alignment float64 `flag:"" help:"Alignment of the scene item."`
|
||||||
BoundsAlignment float64 `flag:"" help:"Bounds 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.
|
// Run executes the command to transform a scene item.
|
||||||
func (cmd *SceneItemTransformCmd) Run(ctx *context) error {
|
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 {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@ -323,8 +350,8 @@ func (cmd *SceneItemTransformCmd) Run(ctx *context) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
if cmd.Parent != "" {
|
if cmd.Group != "" {
|
||||||
fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' transformed.\n", cmd.ItemName, cmd.Parent)
|
fmt.Fprintf(ctx.Out, "Scene item '%s' in group '%s' transformed.\n", cmd.ItemName, cmd.Group)
|
||||||
} else {
|
} else {
|
||||||
fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' transformed.\n", cmd.ItemName, cmd.SceneName)
|
fmt.Fprintf(ctx.Out, "Scene item '%s' in scene '%s' transformed.\n", cmd.ItemName, cmd.SceneName)
|
||||||
}
|
}
|
||||||
|
41
screenshot.go
Normal file
41
screenshot.go
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"path/filepath"
|
||||||
|
|
||||||
|
"github.com/andreykaipov/goobs/api/requests/sources"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ScreenshotCmd provides commands to manage screenshots in OBS Studio.
|
||||||
|
type ScreenshotCmd struct {
|
||||||
|
Save ScreenshotSaveCmd `cmd:"" help:"Take a screenshot and save it to a file." aliases:"sv"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// ScreenshotSaveCmd represents the command to save a screenshot of a source in OBS.
|
||||||
|
type ScreenshotSaveCmd struct {
|
||||||
|
SourceName string `arg:"" help:"Name of the source to take a screenshot of."`
|
||||||
|
FilePath string `arg:"" help:"Path to the file where the screenshot will be saved."`
|
||||||
|
Width float64 ` help:"Width of the screenshot in pixels." flag:"" default:"1920"`
|
||||||
|
Height float64 ` help:"Height of the screenshot in pixels." flag:"" default:"1080"`
|
||||||
|
Quality float64 ` help:"Quality of the screenshot (1-100)." flag:"" default:"-1"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run executes the command to take a screenshot and save it to a file.
|
||||||
|
func (cmd *ScreenshotSaveCmd) Run(ctx *context) error {
|
||||||
|
_, err := ctx.Client.Sources.SaveSourceScreenshot(
|
||||||
|
sources.NewSaveSourceScreenshotParams().
|
||||||
|
WithSourceName(cmd.SourceName).
|
||||||
|
WithImageFormat(trimPrefix(filepath.Ext(cmd.FilePath), ".")).
|
||||||
|
WithImageFilePath(cmd.FilePath).
|
||||||
|
WithImageWidth(cmd.Width).
|
||||||
|
WithImageHeight(cmd.Height).
|
||||||
|
WithImageCompressionQuality(cmd.Quality),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to take screenshot: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Fprintf(ctx.Out, "Screenshot saved to %s.\n", cmd.FilePath)
|
||||||
|
return nil
|
||||||
|
}
|
7
util.go
7
util.go
@ -20,3 +20,10 @@ func getEnabledMark(enabled bool) string {
|
|||||||
}
|
}
|
||||||
return "\u274c" // red cross mark
|
return "\u274c" // red cross mark
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func trimPrefix(s, prefix string) string {
|
||||||
|
if strings.HasPrefix(s, prefix) {
|
||||||
|
return s[len(prefix):]
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
36
version.go
36
version.go
@ -2,13 +2,43 @@ package main
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"runtime/debug"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/alecthomas/kong"
|
||||||
)
|
)
|
||||||
|
|
||||||
// VersionCmd handles the version command.
|
var version string
|
||||||
type VersionCmd struct{} // size = 0x0
|
|
||||||
|
// VersionFlag is a custom flag type for displaying version information.
|
||||||
|
type VersionFlag string
|
||||||
|
|
||||||
|
// Decode implements the kong.Flag interface for VersionFlag.
|
||||||
|
func (v VersionFlag) Decode(_ *kong.DecodeContext) error { return nil }
|
||||||
|
|
||||||
|
// IsBool implements the kong.Flag interface for VersionFlag.
|
||||||
|
func (v VersionFlag) IsBool() bool { return true }
|
||||||
|
|
||||||
|
// BeforeApply implements the kong.Flag interface for VersionFlag.
|
||||||
|
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
|
||||||
|
|
||||||
// Run executes the command to get the OBS client version.
|
// Run executes the command to get the OBS client version.
|
||||||
func (cmd *VersionCmd) Run(ctx *context) error {
|
func (cmd *ObsVersionCmd) Run(ctx *context) error {
|
||||||
version, err := ctx.Client.General.GetVersion()
|
version, err := ctx.Client.General.GetVersion()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
|
@ -16,7 +16,7 @@ func TestVersion(t *testing.T) {
|
|||||||
Out: &out,
|
Out: &out,
|
||||||
}
|
}
|
||||||
|
|
||||||
cmd := &VersionCmd{}
|
cmd := &ObsVersionCmd{}
|
||||||
err := cmd.Run(context)
|
err := cmd.Run(context)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("Failed to get version: %v", err)
|
t.Fatalf("Failed to get version: %v", err)
|
||||||
|
Loading…
x
Reference in New Issue
Block a user