File: xx_generated.stopoutput.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 (47 lines) | stat: -rw-r--r-- 1,376 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
// This file has been automatically generated. Don't edit it.

package outputs

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

/*
StopOutputParams represents the params body for the "StopOutput" request.
Stop an output

Note: Controlling outputs is an experimental feature of obs-websocket. Some plugins which add outputs to OBS may not function properly when they are controlled in this way.
Since 4.7.0.
*/
type StopOutputParams struct {
	requests.ParamsBasic

	// Force stop (default: false)
	Force *bool `json:"force,omitempty"`

	// Output name
	OutputName string `json:"outputName,omitempty"`
}

// GetSelfName just returns "StopOutput".
func (o *StopOutputParams) GetSelfName() string {
	return "StopOutput"
}

/*
StopOutputResponse represents the response body for the "StopOutput" request.
Stop an output

Note: Controlling outputs is an experimental feature of obs-websocket. Some plugins which add outputs to OBS may not function properly when they are controlled in this way.
Since v4.7.0.
*/
type StopOutputResponse struct {
	requests.ResponseBasic
}

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