Package nl.harm27.obs.websocket.sender

Class ReplayBufferRequestSender

java.lang.Object

nl.harm27.obs.websocket.sender.RequestSender

nl.harm27.obs.websocket.sender.ReplayBufferRequestSender

public class ReplayBufferRequestSender
extends RequestSender

Constructor Summary

Constructors

Constructor	Description
ReplayBufferRequestSender(BiConsumer<BaseRequest,Consumer<BaseResponse>> requestConsumer, Consumer<BaseRequest> batchConsumer, Supplier<String> messageIdSupplier)

Method Summary

Modifier and Type	Method	Description
GetReplayBufferStatus.Builder	getReplayBufferStatus()	Get the status of the OBS replay buffer.
SaveReplayBuffer.Builder	saveReplayBuffer()	Flush and save the contents of the Replay Buffer to disk.
StartReplayBuffer.Builder	startReplayBuffer()	Start recording into the Replay Buffer.
StartStopReplayBuffer.Builder	startStopReplayBuffer()	Toggle the Replay Buffer on/off (depending on the current state of the replay buffer).
StopReplayBuffer.Builder	stopReplayBuffer()	Stop recording into the Replay Buffer.

Methods inherited from class nl.harm27.obs.websocket.sender.RequestSender

batchMessage, getNewMessageId, sendMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplayBufferRequestSender

public ReplayBufferRequestSender(BiConsumer<BaseRequest,Consumer<BaseResponse>> requestConsumer,
                                 Consumer<BaseRequest> batchConsumer,
                                 Supplier<String> messageIdSupplier)

Method Detail

getReplayBufferStatus

public GetReplayBufferStatus.Builder getReplayBufferStatus()

Get the status of the OBS replay buffer.

Since:

4.9.0

See Also:

OBS WebSocket Documentation

startStopReplayBuffer

public StartStopReplayBuffer.Builder startStopReplayBuffer()

Toggle the Replay Buffer on/off (depending on the current state of the replay buffer).

Since:

4.2.0

See Also:

OBS WebSocket Documentation

startReplayBuffer

public StartReplayBuffer.Builder startReplayBuffer()

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

See Also:

OBS WebSocket Documentation

stopReplayBuffer

public StopReplayBuffer.Builder stopReplayBuffer()

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

Since:

4.2.0

See Also:

OBS WebSocket Documentation

saveReplayBuffer

public SaveReplayBuffer.Builder saveReplayBuffer()

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

See Also:

OBS WebSocket Documentation