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

package recording

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

/*
SetRecordingFolderParams represents the params body for the "SetRecordingFolder" request.
In the current profile, sets the recording folder of the Simple and Advanced output modes to the specified value.

Note: If `SetRecordingFolder` is called while a recording is
in progress, the change won't be applied immediately and will be
effective on the next recording.
Since 4.1.0.
*/
type SetRecordingFolderParams struct {
	requests.ParamsBasic

	// Path of the recording folder.
	RecFolder string `json:"rec-folder,omitempty"`
}

// GetSelfName just returns "SetRecordingFolder".
func (o *SetRecordingFolderParams) GetSelfName() string {
	return "SetRecordingFolder"
}

/*
SetRecordingFolderResponse represents the response body for the "SetRecordingFolder" request.
In the current profile, sets the recording folder of the Simple and Advanced output modes to the specified value.

Note: If `SetRecordingFolder` is called while a recording is
in progress, the change won't be applied immediately and will be
effective on the next recording.
Since v4.1.0.
*/
type SetRecordingFolderResponse struct {
	requests.ResponseBasic
}

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