mirror of
https://github.com/onyx-and-iris/gobs-cli.git
synced 2025-08-07 20:21:48 +00:00
Compare commits
No commits in common. "0a0c75ae51a6cec0744685ec1d90ed16dc9fdf50" and "17b8e53da3cac591a528c838849511e2498459f9" have entirely different histories.
0a0c75ae51
...
17b8e53da3
18
CHANGELOG.md
18
CHANGELOG.md
@ -5,21 +5,7 @@ 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.2] - 2025-06-04
|
# [0.9.0]
|
||||||
|
|
||||||
### 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
|
### Added
|
||||||
|
|
||||||
@ -29,7 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
|
|
||||||
- version command renamed to obs-version
|
- version command renamed to obs-version
|
||||||
|
|
||||||
# [0.8.2] - 2025-05-29
|
# [0.8.2]
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
|
25
README.md
25
README.md
@ -513,10 +513,6 @@ 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
|
||||||
```
|
```
|
||||||
@ -565,7 +561,7 @@ gobs-cli projector list-monitors
|
|||||||
- defaults to 0
|
- defaults to 0
|
||||||
|
|
||||||
*optional*
|
*optional*
|
||||||
- args: SourceName
|
- args: <source_name>
|
||||||
- defaults to current scene
|
- defaults to current scene
|
||||||
|
|
||||||
```console
|
```console
|
||||||
@ -576,25 +572,6 @@ 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
|
31
filter.go
31
filter.go
@ -2,7 +2,6 @@ package main
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"maps"
|
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
@ -21,27 +20,19 @@ 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." default:""`
|
SourceName string `arg:"" help:"Name of the source to list filters from."`
|
||||||
}
|
}
|
||||||
|
|
||||||
// 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 {
|
||||||
if cmd.SourceName == "" {
|
filters, err := ctx.Client.Filters.GetSourceFilterList(
|
||||||
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(sourceFilters.Filters) == 0 {
|
if len(filters.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
|
||||||
}
|
}
|
||||||
@ -51,20 +42,10 @@ 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 sourceFilters.Filters {
|
for _, filter := range filters.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 defaultSettings.DefaultFilterSettings {
|
for k, v := range filter.FilterSettings {
|
||||||
lines = append(lines, fmt.Sprintf("%s: %v", snakeCaseToTitleCase(k), v))
|
lines = append(lines, fmt.Sprintf("%s %v", 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])
|
||||||
|
1
main.go
1
main.go
@ -47,7 +47,6 @@ type CLI struct {
|
|||||||
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 {
|
||||||
|
@ -71,11 +71,11 @@ func (cmd *SceneItemListCmd) Run(ctx *context) error {
|
|||||||
fmt.Sprintf("%d", groupItem.SceneItemID),
|
fmt.Sprintf("%d", groupItem.SceneItemID),
|
||||||
groupItem.SourceName,
|
groupItem.SourceName,
|
||||||
item.SourceName,
|
item.SourceName,
|
||||||
getEnabledMark(item.SceneItemEnabled && groupItem.SceneItemEnabled),
|
fmt.Sprintf("%t", item.SceneItemEnabled && groupItem.SceneItemEnabled),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
t.AddRow(fmt.Sprintf("%d", item.SceneItemID), item.SourceName, "", getEnabledMark(item.SceneItemEnabled))
|
t.AddRow(fmt.Sprintf("%d", item.SceneItemID), item.SourceName, "", fmt.Sprintf("%t", item.SceneItemEnabled))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
t.Render()
|
t.Render()
|
||||||
|
@ -1,41 +0,0 @@
|
|||||||
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
|
|
||||||
}
|
|
Loading…
x
Reference in New Issue
Block a user