Package nl.harm27.obswebsocket.sender

Class ReplayBufferRequestSender

java.lang.Object

nl.harm27.obswebsocket.sender.RequestSender

nl.harm27.obswebsocket.sender.ReplayBufferRequestSender

public class ReplayBufferRequestSender
extends RequestSender

The RequestSender for the requests that are part of the Replay Buffer category.

Constructor Summary

Constructors

Constructor	Description
ReplayBufferRequestSender(OBSWebSocket obsWebSocket)

Method Summary

Modifier and Type	Method	Description
void	saveReplayBuffer(Consumer<SaveReplayBuffer.Response> responseConsumer)	Flush and save the contents of the Replay Buffer to disk.
void	startReplayBuffer(Consumer<StartReplayBuffer.Response> responseConsumer)	Start recording into the Replay Buffer.
void	startStopReplayBuffer(Consumer<StartStopReplayBuffer.Response> responseConsumer)	Toggle the Replay Buffer on/off.
void	stopReplayBuffer(Consumer<StopReplayBuffer.Response> responseConsumer)	Stop recording into the Replay Buffer.

Methods inherited from class nl.harm27.obswebsocket.sender.RequestSender

getNextMessageId, sendRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReplayBufferRequestSender

public ReplayBufferRequestSender(OBSWebSocket obsWebSocket)

Method Detail

startStopReplayBuffer

public void startStopReplayBuffer(Consumer<StartStopReplayBuffer.Response> responseConsumer)

Toggle the Replay Buffer on/off.

Since:

v4.2.0

See Also:

OBS WebSocket Documentation

startReplayBuffer

public void startReplayBuffer(Consumer<StartReplayBuffer.Response> responseConsumer)

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

See Also:

OBS WebSocket Documentation

stopReplayBuffer

public void stopReplayBuffer(Consumer<StopReplayBuffer.Response> responseConsumer)

Stop recording into the Replay Buffer. Will return an error if the Replay Buffer is not active.

Since:

v4.2.0

See Also:

OBS WebSocket Documentation

saveReplayBuffer

public void saveReplayBuffer(Consumer<SaveReplayBuffer.Response> responseConsumer)

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

See Also:

OBS WebSocket Documentation