Package nl.harm27.obs.websocket.sender

Class StreamingRequestSender

java.lang.Object

nl.harm27.obs.websocket.sender.RequestSender

nl.harm27.obs.websocket.sender.StreamingRequestSender

public class StreamingRequestSender
extends RequestSender

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GetStreamingStatus.Builder	getStreamingStatus()	Get current streaming and recording status.
GetStreamSettings.Builder	getStreamSettings()	Get the current streaming server settings.
SaveStreamSettings.Builder	saveStreamSettings()	Save the current streaming server settings to disk.
SendCaptions.Builder	sendCaptions()	Send the provided text as embedded CEA-608 caption data.
SetStreamSettings.Builder	setStreamSettings()	Sets one or more attributes of the current streaming server settings.
StartStopStreaming.Builder	startStopStreaming()	Toggle streaming on or off (depending on the current stream state).
StartStreaming.Builder	startStreaming()	Start streaming.
StopStreaming.Builder	stopStreaming()	Stop streaming.

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

StreamingRequestSender

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

Method Detail

getStreamingStatus

public GetStreamingStatus.Builder getStreamingStatus()

Get current streaming and recording status.

Since:

0.3

See Also:

OBS WebSocket Documentation

startStopStreaming

public StartStopStreaming.Builder startStopStreaming()

Toggle streaming on or off (depending on the current stream state).

Since:

0.3

See Also:

OBS WebSocket Documentation

startStreaming

public StartStreaming.Builder startStreaming()

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

Since:

4.1.0

See Also:

OBS WebSocket Documentation

stopStreaming

public StopStreaming.Builder stopStreaming()

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

Since:

4.1.0

See Also:

OBS WebSocket Documentation

setStreamSettings

public SetStreamSettings.Builder setStreamSettings()

Sets one or more attributes of the current streaming server settings. Any options not passed will remain unchanged. Returns the updated settings in response. If 'type' is different than the current streaming service type, all settings are required. Returns the full settings of the stream (the same as GetStreamSettings).

Since:

4.1.0

See Also:

OBS WebSocket Documentation

getStreamSettings

public GetStreamSettings.Builder getStreamSettings()

Get the current streaming server settings.

Since:

4.1.0

See Also:

OBS WebSocket Documentation

saveStreamSettings

public SaveStreamSettings.Builder saveStreamSettings()

Save the current streaming server settings to disk.

Since:

4.1.0

See Also:

OBS WebSocket Documentation

sendCaptions

public SendCaptions.Builder sendCaptions()

Send the provided text as embedded CEA-608 caption data.

Since:

4.6.0

See Also:

OBS WebSocket Documentation