Package nl.harm27.obs.websocket.sender

Class StudioModeRequestSender

java.lang.Object

nl.harm27.obs.websocket.sender.RequestSender

nl.harm27.obs.websocket.sender.StudioModeRequestSender

public class StudioModeRequestSender
extends RequestSender

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DisableStudioMode.Builder	disableStudioMode()	Disables Studio Mode.
EnableStudioMode.Builder	enableStudioMode()	Enables Studio Mode.
GetPreviewScene.Builder	getPreviewScene()	Get the name of the currently previewed scene and its list of sources.
GetStudioModeStatus.Builder	getStudioModeStatus()	Indicates if Studio Mode is currently enabled.
SetPreviewScene.Builder	setPreviewScene()	Set the active preview scene.
ToggleStudioMode.Builder	toggleStudioMode()	Toggles Studio Mode (depending on the current state of studio mode).
TransitionToProgram.Builder	transitionToProgram()	Transitions the currently previewed scene to the main output.

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

StudioModeRequestSender

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

Method Detail

getStudioModeStatus

public GetStudioModeStatus.Builder getStudioModeStatus()

Indicates if Studio Mode is currently enabled.

Since:

4.1.0

See Also:

OBS WebSocket Documentation

getPreviewScene

public GetPreviewScene.Builder getPreviewScene()

Get the name of the currently previewed scene and its list of sources. Will return an `error` if Studio Mode is not enabled.

Since:

4.1.0

See Also:

OBS WebSocket Documentation

setPreviewScene

public SetPreviewScene.Builder setPreviewScene()

Set the active preview scene. Will return an `error` if Studio Mode is not enabled.

Since:

4.1.0

See Also:

OBS WebSocket Documentation

transitionToProgram

public TransitionToProgram.Builder transitionToProgram()

Transitions the currently previewed scene to the main output. Will return an `error` if Studio Mode is not enabled.

Since:

4.1.0

See Also:

OBS WebSocket Documentation

enableStudioMode

public EnableStudioMode.Builder enableStudioMode()

Enables Studio Mode.

Since:

4.1.0

See Also:

OBS WebSocket Documentation

disableStudioMode

public DisableStudioMode.Builder disableStudioMode()

Disables Studio Mode.

Since:

4.1.0

See Also:

OBS WebSocket Documentation

toggleStudioMode

public ToggleStudioMode.Builder toggleStudioMode()

Toggles Studio Mode (depending on the current state of studio mode).

Since:

4.1.0

See Also:

OBS WebSocket Documentation