replaybuffer

Documentation

Index

• type Client
  • func (c *Client) GetReplayBufferStatus(paramss ...*GetReplayBufferStatusParams) (*GetReplayBufferStatusResponse, error)
  • 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 GetReplayBufferStatusParams
  • func (o *GetReplayBufferStatusParams) GetSelfName() string
• type GetReplayBufferStatusResponse
• type SaveReplayBufferParams
  • func (o *SaveReplayBufferParams) GetSelfName() string
• type SaveReplayBufferResponse
• type StartReplayBufferParams
  • func (o *StartReplayBufferParams) GetSelfName() string
• type StartReplayBufferResponse
• type StartStopReplayBufferParams
  • func (o *StartStopReplayBufferParams) GetSelfName() string
• type StartStopReplayBufferResponse
• type StopReplayBufferParams
  • func (o *StopReplayBufferParams) GetSelfName() string
• type StopReplayBufferResponse

Types

type Client

type Client struct {
	*requests.Client
}

Client represents a client for 'replay buffer' requests.

func (*Client) GetReplayBufferStatus

func (c *Client) GetReplayBufferStatus(
	paramss ...*GetReplayBufferStatusParams,
) (*GetReplayBufferStatusResponse, error)

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

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 GetReplayBufferStatusParams

type GetReplayBufferStatusParams struct {
	requests.ParamsBasic
}

GetReplayBufferStatusParams represents the params body for the "GetReplayBufferStatus" request. Get the status of the OBS replay buffer. Since 4.9.0.

func (*GetReplayBufferStatusParams) GetSelfName

func (o *GetReplayBufferStatusParams) GetSelfName() string

GetSelfName just returns "GetReplayBufferStatus".

type GetReplayBufferStatusResponse

type GetReplayBufferStatusResponse struct {
	requests.ResponseBasic

	// Current recording status.
	IsReplayBufferActive bool `json:"isReplayBufferActive"`
}

GetReplayBufferStatusResponse represents the response body for the "GetReplayBufferStatus" request. Get the status of the OBS replay buffer. Since v4.9.0.

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. Since 4.2.0.

func (*SaveReplayBufferParams) GetSelfName

func (o *SaveReplayBufferParams) GetSelfName() string

GetSelfName 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. Since v4.2.0.

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. Since 4.2.0.

func (*StartReplayBufferParams) GetSelfName

func (o *StartReplayBufferParams) GetSelfName() string

GetSelfName 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. Since v4.2.0.

type StartStopReplayBufferParams

type StartStopReplayBufferParams struct {
	requests.ParamsBasic
}

StartStopReplayBufferParams represents the params body for the "StartStopReplayBuffer" request. Toggle the Replay Buffer on/off (depending on the current state of the replay buffer). Since 4.2.0.

func (*StartStopReplayBufferParams) GetSelfName

func (o *StartStopReplayBufferParams) GetSelfName() string

GetSelfName 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 (depending on the current state of the replay buffer). Since v4.2.0.

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. Since 4.2.0.

func (*StopReplayBufferParams) GetSelfName

func (o *StopReplayBufferParams) GetSelfName() string

GetSelfName 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. Since v4.2.0.