Package nl.harm27.obswebsocket.sender

Class StudioModeRequestSender

java.lang.Object

nl.harm27.obswebsocket.sender.RequestSender

nl.harm27.obswebsocket.sender.StudioModeRequestSender

public class StudioModeRequestSender
extends RequestSender

The RequestSender for the requests that are part of the Studio Mode category.

Constructor Summary

Constructors

Constructor	Description
StudioModeRequestSender(OBSWebSocket obsWebSocket)

Method Summary

Modifier and Type	Method	Description
void	disableStudioMode(Consumer<DisableStudioMode.Response> responseConsumer)	Disables Studio Mode.
void	enableStudioMode(Consumer<EnableStudioMode.Response> responseConsumer)	Enables Studio Mode.
void	getPreviewScene(Consumer<GetPreviewScene.Response> responseConsumer)	Get the name of the currently previewed scene and its list of sources.
void	getStudioModeStatus(Consumer<GetStudioModeStatus.Response> responseConsumer)	Indicates if Studio Mode is currently enabled.
void	setPreviewScene(String sceneName, Consumer<SetPreviewScene.Response> responseConsumer)	Set the active preview scene.
void	toggleStudioMode(Consumer<ToggleStudioMode.Response> responseConsumer)	Toggles Studio Mode.
void	transitionToProgram(TransitionToProgram.Transition transition, Consumer<TransitionToProgram.Response> responseConsumer)	Transitions the currently previewed scene to the main output.

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

StudioModeRequestSender

public StudioModeRequestSender(OBSWebSocket obsWebSocket)

Method Detail

getStudioModeStatus

public void getStudioModeStatus(Consumer<GetStudioModeStatus.Response> responseConsumer)

Indicates if Studio Mode is currently enabled.

Since:

v4.1.0

See Also:

OBS WebSocket Documentation

getPreviewScene

public void getPreviewScene(Consumer<GetPreviewScene.Response> responseConsumer)

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

Since:

v4.1.0

See Also:

OBS WebSocket Documentation

setPreviewScene

public void setPreviewScene(String sceneName,
                            Consumer<SetPreviewScene.Response> responseConsumer)

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

Parameters:

sceneName - The name of the scene to preview.

Since:

v4.1.0

See Also:

OBS WebSocket Documentation

transitionToProgram

public void transitionToProgram(TransitionToProgram.Transition transition,
                                Consumer<TransitionToProgram.Response> responseConsumer)

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

Parameters:

transition - Change the active transition before switching scenes. Defaults to the active transition.

Since:

v4.1.0

See Also:

OBS WebSocket Documentation

enableStudioMode

public void enableStudioMode(Consumer<EnableStudioMode.Response> responseConsumer)

Enables Studio Mode.

Since:

v4.1.0

See Also:

OBS WebSocket Documentation

disableStudioMode

public void disableStudioMode(Consumer<DisableStudioMode.Response> responseConsumer)

Disables Studio Mode.

Since:

v4.1.0

See Also:

OBS WebSocket Documentation

toggleStudioMode

public void toggleStudioMode(Consumer<ToggleStudioMode.Response> responseConsumer)

Toggles Studio Mode.

Since:

v4.1.0

See Also:

OBS WebSocket Documentation