recording

Documentation

Index

• type Client
  • func (c *Client) GetRecordingFolder(paramss ...*GetRecordingFolderParams) (*GetRecordingFolderResponse, error)
  • func (c *Client) SetRecordingFolder(params *SetRecordingFolderParams) (*SetRecordingFolderResponse, error)
  • func (c *Client) StartRecording(paramss ...*StartRecordingParams) (*StartRecordingResponse, error)
  • func (c *Client) StartStopRecording(paramss ...*StartStopRecordingParams) (*StartStopRecordingResponse, error)
  • func (c *Client) StopRecording(paramss ...*StopRecordingParams) (*StopRecordingResponse, error)
• type GetRecordingFolderParams
  • func (o *GetRecordingFolderParams) Name() string
• type GetRecordingFolderResponse
• type SetRecordingFolderParams
  • func (o *SetRecordingFolderParams) Name() string
• type SetRecordingFolderResponse
• type StartRecordingParams
  • func (o *StartRecordingParams) Name() string
• type StartRecordingResponse
• type StartStopRecordingParams
  • func (o *StartStopRecordingParams) Name() string
• type StartStopRecordingResponse
• type StopRecordingParams
  • func (o *StopRecordingParams) Name() string
• type StopRecordingResponse

Types

type Client

type Client struct {
	*requests.Client
}

Client represents a client for 'recording' requests

func (*Client) GetRecordingFolder

func (c *Client) GetRecordingFolder(
	paramss ...*GetRecordingFolderParams,
) (*GetRecordingFolderResponse, error)

GetRecordingFolder sends the corresponding request to the connected OBS WebSockets server. Note the variadic arguments as this request doesn't require any parameters.

func (*Client) SetRecordingFolder

func (c *Client) SetRecordingFolder(
	params *SetRecordingFolderParams,
) (*SetRecordingFolderResponse, error)

SetRecordingFolder sends the corresponding request to the connected OBS WebSockets server.

func (*Client) StartRecording

func (c *Client) StartRecording(paramss ...*StartRecordingParams) (*StartRecordingResponse, error)

StartRecording sends the corresponding request to the connected OBS WebSockets server. Note the variadic arguments as this request doesn't require any parameters.

func (*Client) StartStopRecording

func (c *Client) StartStopRecording(
	paramss ...*StartStopRecordingParams,
) (*StartStopRecordingResponse, error)

StartStopRecording sends the corresponding request to the connected OBS WebSockets server. Note the variadic arguments as this request doesn't require any parameters.

func (*Client) StopRecording

func (c *Client) StopRecording(paramss ...*StopRecordingParams) (*StopRecordingResponse, error)

StopRecording sends the corresponding request to the connected OBS WebSockets server. Note the variadic arguments as this request doesn't require any parameters.

type GetRecordingFolderParams

type GetRecordingFolderParams struct {
	requests.ParamsBasic
}

GetRecordingFolderParams represents the params body for the "GetRecordingFolder" request. Get the path of the current recording folder.

Generated from https://github.com/Palakis/obs-websocket/blob/4.6.1/docs/generated/protocol.md#GetRecordingFolder.

func (*GetRecordingFolderParams) Name

func (o *GetRecordingFolderParams) Name() string

Name just returns "GetRecordingFolder".

type GetRecordingFolderResponse

type GetRecordingFolderResponse struct {
	requests.ResponseBasic

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

GetRecordingFolderResponse represents the response body for the "GetRecordingFolder" request. Get the path of the current recording folder.

Generated from https://github.com/Palakis/obs-websocket/blob/4.6.1/docs/generated/protocol.md#GetRecordingFolder.

type SetRecordingFolderParams

type SetRecordingFolderParams struct {
	requests.ParamsBasic

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

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.

Please 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.

Generated from https://github.com/Palakis/obs-websocket/blob/4.6.1/docs/generated/protocol.md#SetRecordingFolder.

func (*SetRecordingFolderParams) Name

func (o *SetRecordingFolderParams) Name() string

Name just returns "SetRecordingFolder".

type SetRecordingFolderResponse

type SetRecordingFolderResponse struct {
	requests.ResponseBasic
}

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.

Please 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.

Generated from https://github.com/Palakis/obs-websocket/blob/4.6.1/docs/generated/protocol.md#SetRecordingFolder.

type StartRecordingParams

type StartRecordingParams struct {
	requests.ParamsBasic
}

StartRecordingParams represents the params body for the "StartRecording" request. Start recording. Will return an `error` if recording is already active.

Generated from https://github.com/Palakis/obs-websocket/blob/4.6.1/docs/generated/protocol.md#StartRecording.

func (*StartRecordingParams) Name

func (o *StartRecordingParams) Name() string

Name just returns "StartRecording".

type StartRecordingResponse

type StartRecordingResponse struct {
	requests.ResponseBasic
}

StartRecordingResponse represents the response body for the "StartRecording" request. Start recording. Will return an `error` if recording is already active.

Generated from https://github.com/Palakis/obs-websocket/blob/4.6.1/docs/generated/protocol.md#StartRecording.

type StartStopRecordingParams

type StartStopRecordingParams struct {
	requests.ParamsBasic
}

StartStopRecordingParams represents the params body for the "StartStopRecording" request. Toggle recording on or off.

Generated from https://github.com/Palakis/obs-websocket/blob/4.6.1/docs/generated/protocol.md#StartStopRecording.

func (*StartStopRecordingParams) Name

func (o *StartStopRecordingParams) Name() string

Name just returns "StartStopRecording".

type StartStopRecordingResponse

type StartStopRecordingResponse struct {
	requests.ResponseBasic
}

StartStopRecordingResponse represents the response body for the "StartStopRecording" request. Toggle recording on or off.

Generated from https://github.com/Palakis/obs-websocket/blob/4.6.1/docs/generated/protocol.md#StartStopRecording.

type StopRecordingParams

type StopRecordingParams struct {
	requests.ParamsBasic
}

StopRecordingParams represents the params body for the "StopRecording" request. Stop recording. Will return an `error` if recording is not active.

Generated from https://github.com/Palakis/obs-websocket/blob/4.6.1/docs/generated/protocol.md#StopRecording.

func (*StopRecordingParams) Name

func (o *StopRecordingParams) Name() string

Name just returns "StopRecording".

type StopRecordingResponse

type StopRecordingResponse struct {
	requests.ResponseBasic
}

StopRecordingResponse represents the response body for the "StopRecording" request. Stop recording. Will return an `error` if recording is not active.

Generated from https://github.com/Palakis/obs-websocket/blob/4.6.1/docs/generated/protocol.md#StopRecording.