Package nl.harm27.obswebsocket.sender

Class RecordingRequestSender

java.lang.Object

nl.harm27.obswebsocket.sender.RequestSender

nl.harm27.obswebsocket.sender.RecordingRequestSender

public class RecordingRequestSender
extends RequestSender

The RequestSender for the requests that are part of the Recording category.

Constructor Summary

Constructors

Constructor	Description
RecordingRequestSender(OBSWebSocket obsWebSocket)

Method Summary

Modifier and Type	Method	Description
void	getRecordingFolder(Consumer<GetRecordingFolder.Response> responseConsumer)	Get the path of the current recording folder.
void	pauseRecording(Consumer<PauseRecording.Response> responseConsumer)	Pause the current recording.
void	resumeRecording(Consumer<ResumeRecording.Response> responseConsumer)	Resume/unpause the current recording (if paused).
void	setRecordingFolder(String recFolder, Consumer<SetRecordingFolder.Response> responseConsumer)	Please 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.
void	startRecording(Consumer<StartRecording.Response> responseConsumer)	Start recording.
void	startStopRecording(Consumer<StartStopRecording.Response> responseConsumer)	Toggle recording on or off.
void	stopRecording(Consumer<StopRecording.Response> responseConsumer)	Stop recording.

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

RecordingRequestSender

public RecordingRequestSender(OBSWebSocket obsWebSocket)

Method Detail

startStopRecording

public void startStopRecording(Consumer<StartStopRecording.Response> responseConsumer)

Toggle recording on or off.

Since:

v0.3

See Also:

OBS WebSocket Documentation

startRecording

public void startRecording(Consumer<StartRecording.Response> responseConsumer)

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

Since:

v4.1.0

See Also:

OBS WebSocket Documentation

stopRecording

public void stopRecording(Consumer<StopRecording.Response> responseConsumer)

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

Since:

v4.1.0

See Also:

OBS WebSocket Documentation

pauseRecording

public void pauseRecording(Consumer<PauseRecording.Response> responseConsumer)

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

Since:

v4.7.0

See Also:

OBS WebSocket Documentation

resumeRecording

public void resumeRecording(Consumer<ResumeRecording.Response> responseConsumer)

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

Since:

v4.7.0

See Also:

OBS WebSocket Documentation

getRecordingFolder

public void getRecordingFolder(Consumer<GetRecordingFolder.Response> responseConsumer)

Get the path of the current recording folder.

Since:

v4.1.0

See Also:

OBS WebSocket Documentation

setRecordingFolder

public void setRecordingFolder(String recFolder,
                               Consumer<SetRecordingFolder.Response> responseConsumer)

Please 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:

v4.1.0

See Also:

OBS WebSocket Documentation