File: xx_generated.setsceneitemrender.go

package info (click to toggle)
golang-github-andreykaipov-goobs 0.8.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 1,228 kB
  • sloc: makefile: 32
file content (49 lines) | stat: -rw-r--r-- 1,419 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
// This file has been automatically generated. Don't edit it.

package sceneitems

import requests "github.com/andreykaipov/goobs/api/requests"

/*
SetSceneItemRenderParams represents the params body for the "SetSceneItemRender" request.
Show or hide a specified source item in a specified scene.
Since 0.3.
*/
type SetSceneItemRenderParams struct {
	requests.ParamsBasic

	// Scene Item id
	Item int `json:"item,omitempty"`

	// true = shown ; false = hidden
	Render *bool `json:"render,omitempty"`

	// Name of the scene the scene item belongs to. Defaults to the currently active scene.
	SceneName string `json:"scene-name,omitempty"`

	// Scene Item name.
	Source string `json:"source,omitempty"`
}

// GetSelfName just returns "SetSceneItemRender".
func (o *SetSceneItemRenderParams) GetSelfName() string {
	return "SetSceneItemRender"
}

/*
SetSceneItemRenderResponse represents the response body for the "SetSceneItemRender" request.
Show or hide a specified source item in a specified scene.
Since v0.3.
*/
type SetSceneItemRenderResponse struct {
	requests.ResponseBasic
}

// SetSceneItemRender sends the corresponding request to the connected OBS WebSockets server.
func (c *Client) SetSceneItemRender(params *SetSceneItemRenderParams) (*SetSceneItemRenderResponse, error) {
	data := &SetSceneItemRenderResponse{}
	if err := c.SendRequest(params, data); err != nil {
		return nil, err
	}
	return data, nil
}