recording

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 14, 2021 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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) PauseRecording added in v0.3.0 

func (c *Client) PauseRecording(paramss ...*PauseRecordingParams) (*PauseRecordingResponse, error)

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

func (*Client) ResumeRecording added in v0.3.0 

func (c *Client) ResumeRecording(
	paramss ...*ResumeRecordingParams,
) (*ResumeRecordingResponse, error)

ResumeRecording 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.7.0/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.7.0/docs/generated/protocol.md#GetRecordingFolder.

type PauseRecordingParams added in v0.3.0 

type PauseRecordingParams struct {
	requests.ParamsBasic
}

PauseRecordingParams represents the params body for the "PauseRecording" request. Pause the current recording. Returns an error if recording is not active or already paused.

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

func (*PauseRecordingParams) Name added in v0.3.0 

func (o *PauseRecordingParams) Name() string

Name just returns "PauseRecording".

type PauseRecordingResponse added in v0.3.0 

type PauseRecordingResponse struct {
	requests.ResponseBasic
}

PauseRecordingResponse represents the response body for the "PauseRecording" request. Pause the current recording. Returns an error if recording is not active or already paused.

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

type ResumeRecordingParams added in v0.3.0 

type ResumeRecordingParams struct {
	requests.ParamsBasic
}

ResumeRecordingParams represents the params body for the "ResumeRecording" request. Resume/unpause the current recording (if paused). Returns an error if recording is not active or not paused.

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

func (*ResumeRecordingParams) Name added in v0.3.0 

func (o *ResumeRecordingParams) Name() string

Name just returns "ResumeRecording".

type ResumeRecordingResponse added in v0.3.0 

type ResumeRecordingResponse struct {
	requests.ResponseBasic
}

ResumeRecordingResponse represents the response body for the "ResumeRecording" request. Resume/unpause the current recording (if paused). Returns an error if recording is not active or not paused.

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

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.7.0/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.7.0/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.7.0/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.7.0/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.7.0/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.7.0/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.7.0/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.7.0/docs/generated/protocol.md#StopRecording.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.