Package nl.harm27.obs.websocket.sender

Class RecordingRequestSender

java.lang.Object

nl.harm27.obs.websocket.sender.RequestSender

nl.harm27.obs.websocket.sender.RecordingRequestSender

public class RecordingRequestSender
extends RequestSender

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GetRecordingFolder.Builder	getRecordingFolder()	Get the path of the current recording folder.
GetRecordingStatus.Builder	getRecordingStatus()	Get current recording status.
PauseRecording.Builder	pauseRecording()	Pause the current recording.
ResumeRecording.Builder	resumeRecording()	Resume/unpause the current recording (if paused).
SetRecordingFolder.Builder	setRecordingFolder()	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.
StartRecording.Builder	startRecording()	Start recording.
StartStopRecording.Builder	startStopRecording()	Toggle recording on or off (depending on the current recording state).
StopRecording.Builder	stopRecording()	Stop recording.

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

RecordingRequestSender

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

Method Detail

getRecordingStatus

public GetRecordingStatus.Builder getRecordingStatus()

Get current recording status.

Since:

4.9.0

See Also:

OBS WebSocket Documentation

startStopRecording

public StartStopRecording.Builder startStopRecording()

Toggle recording on or off (depending on the current recording state).

Since:

0.3

See Also:

OBS WebSocket Documentation

startRecording

public StartRecording.Builder startRecording()

Start recording. Will return an `error` if recording is already active.

Since:

4.1.0

See Also:

OBS WebSocket Documentation

stopRecording

public StopRecording.Builder stopRecording()

Stop recording. Will return an `error` if recording is not active.

Since:

4.1.0

See Also:

OBS WebSocket Documentation

pauseRecording

public PauseRecording.Builder pauseRecording()

Pause the current recording. Returns an error if recording is not active or already paused.

Since:

4.7.0

See Also:

OBS WebSocket Documentation

resumeRecording

public ResumeRecording.Builder resumeRecording()

Resume/unpause the current recording (if paused). Returns an error if recording is not active or not paused.

Since:

4.7.0

See Also:

OBS WebSocket Documentation

setRecordingFolder

public SetRecordingFolder.Builder setRecordingFolder()

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.

Since:

4.1.0

See Also:

OBS WebSocket Documentation

getRecordingFolder

public GetRecordingFolder.Builder getRecordingFolder()

Get the path of the current recording folder.

Since:

4.1.0

See Also:

OBS WebSocket Documentation