replaybuffer

Documentation

Index

• type Client
  • func (c *Client) SaveReplayBuffer(paramss ...*SaveReplayBufferParams) (*SaveReplayBufferResponse, error)
  • func (c *Client) StartReplayBuffer(paramss ...*StartReplayBufferParams) (*StartReplayBufferResponse, error)
  • func (c *Client) StartStopReplayBuffer(paramss ...*StartStopReplayBufferParams) (*StartStopReplayBufferResponse, error)
  • func (c *Client) StopReplayBuffer(paramss ...*StopReplayBufferParams) (*StopReplayBufferResponse, error)
• type SaveReplayBufferParams
  • func (o *SaveReplayBufferParams) Name() string
• type SaveReplayBufferResponse
• type StartReplayBufferParams
  • func (o *StartReplayBufferParams) Name() string
• type StartReplayBufferResponse
• type StartStopReplayBufferParams
  • func (o *StartStopReplayBufferParams) Name() string
• type StartStopReplayBufferResponse
• type StopReplayBufferParams
  • func (o *StopReplayBufferParams) Name() string
• type StopReplayBufferResponse

Types

type Client

type Client struct {
	*requests.Client
}

Client represents a client for 'replay buffer' requests

func (*Client) SaveReplayBuffer

func (c *Client) SaveReplayBuffer(
	paramss ...*SaveReplayBufferParams,
) (*SaveReplayBufferResponse, error)

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

func (*Client) StartReplayBuffer

func (c *Client) StartReplayBuffer(
	paramss ...*StartReplayBufferParams,
) (*StartReplayBufferResponse, error)

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

func (*Client) StartStopReplayBuffer

func (c *Client) StartStopReplayBuffer(
	paramss ...*StartStopReplayBufferParams,
) (*StartStopReplayBufferResponse, error)

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

func (*Client) StopReplayBuffer

func (c *Client) StopReplayBuffer(
	paramss ...*StopReplayBufferParams,
) (*StopReplayBufferResponse, error)

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

type SaveReplayBufferParams

type SaveReplayBufferParams struct {
	requests.ParamsBasic
}

SaveReplayBufferParams represents the params body for the "SaveReplayBuffer" request. Flush and save the contents of the Replay Buffer to disk. This is basically the same as triggering the "Save Replay Buffer" hotkey. Will return an `error` if the Replay Buffer is not active.

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

func (*SaveReplayBufferParams) Name

func (o *SaveReplayBufferParams) Name() string

Name just returns "SaveReplayBuffer".

type SaveReplayBufferResponse

type SaveReplayBufferResponse struct {
	requests.ResponseBasic
}

SaveReplayBufferResponse represents the response body for the "SaveReplayBuffer" request. Flush and save the contents of the Replay Buffer to disk. This is basically the same as triggering the "Save Replay Buffer" hotkey. Will return an `error` if the Replay Buffer is not active.

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

type StartReplayBufferParams

type StartReplayBufferParams struct {
	requests.ParamsBasic
}

StartReplayBufferParams represents the params body for the "StartReplayBuffer" request. Start recording into the Replay Buffer. Will return an `error` if the Replay Buffer is already active or if the "Save Replay Buffer" hotkey is not set in OBS' settings. Setting this hotkey is mandatory, even when triggering saves only through obs-websocket.

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

func (*StartReplayBufferParams) Name

func (o *StartReplayBufferParams) Name() string

Name just returns "StartReplayBuffer".

type StartReplayBufferResponse

type StartReplayBufferResponse struct {
	requests.ResponseBasic
}

StartReplayBufferResponse represents the response body for the "StartReplayBuffer" request. Start recording into the Replay Buffer. Will return an `error` if the Replay Buffer is already active or if the "Save Replay Buffer" hotkey is not set in OBS' settings. Setting this hotkey is mandatory, even when triggering saves only through obs-websocket.

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

type StartStopReplayBufferParams

type StartStopReplayBufferParams struct {
	requests.ParamsBasic
}

StartStopReplayBufferParams represents the params body for the "StartStopReplayBuffer" request. Toggle the Replay Buffer on/off.

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

func (*StartStopReplayBufferParams) Name

func (o *StartStopReplayBufferParams) Name() string

Name just returns "StartStopReplayBuffer".

type StartStopReplayBufferResponse

type StartStopReplayBufferResponse struct {
	requests.ResponseBasic
}

StartStopReplayBufferResponse represents the response body for the "StartStopReplayBuffer" request. Toggle the Replay Buffer on/off.

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

type StopReplayBufferParams

type StopReplayBufferParams struct {
	requests.ParamsBasic
}

StopReplayBufferParams represents the params body for the "StopReplayBuffer" request. Stop recording into the Replay Buffer. Will return an `error` if the Replay Buffer is not active.

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

func (*StopReplayBufferParams) Name

func (o *StopReplayBufferParams) Name() string

Name just returns "StopReplayBuffer".

type StopReplayBufferResponse

type StopReplayBufferResponse struct {
	requests.ResponseBasic
}

StopReplayBufferResponse represents the response body for the "StopReplayBuffer" request. Stop recording into the Replay Buffer. Will return an `error` if the Replay Buffer is not active.

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