Package nl.harm27.obswebsocket.sender

Class ScenesRequestSender

java.lang.Object

nl.harm27.obswebsocket.sender.RequestSender

nl.harm27.obswebsocket.sender.ScenesRequestSender

public class ScenesRequestSender
extends RequestSender

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

Constructor Summary

Constructors

Constructor	Description
ScenesRequestSender(OBSWebSocket obsWebSocket)

Method Summary

Modifier and Type	Method	Description
void	getCurrentScene(Consumer<GetCurrentScene.Response> responseConsumer)	Get the current scene's name and source items.
void	getSceneList(Consumer<GetSceneList.Response> responseConsumer)	Get a list of scenes in the currently active profile.
void	reorderSceneItems(String scene, List<SceneItem> items, Consumer<ReorderSceneItems.Response> responseConsumer)	Changes the order of scene items in the requested scene.
void	setCurrentScene(String sceneName, Consumer<SetCurrentScene.Response> responseConsumer)	Switch to the specified scene.

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

ScenesRequestSender

public ScenesRequestSender(OBSWebSocket obsWebSocket)

Method Detail

setCurrentScene

public void setCurrentScene(String sceneName,
                            Consumer<SetCurrentScene.Response> responseConsumer)

Switch to the specified scene.

Parameters:

sceneName - Name of the scene to switch to.

Since:

v0.3

See Also:

OBS WebSocket Documentation

getCurrentScene

public void getCurrentScene(Consumer<GetCurrentScene.Response> responseConsumer)

Get the current scene's name and source items.

Since:

v0.3

See Also:

OBS WebSocket Documentation

getSceneList

public void getSceneList(Consumer<GetSceneList.Response> responseConsumer)

Get a list of scenes in the currently active profile.

Since:

v0.3

See Also:

OBS WebSocket Documentation

reorderSceneItems

public void reorderSceneItems(String scene,
                              List<SceneItem> items,
                              Consumer<ReorderSceneItems.Response> responseConsumer)

Changes the order of scene items in the requested scene.

Parameters:

scene - Name of the scene to reorder (defaults to current).

items - Ordered list of objects with name and/or id specified. Id preferred due to uniqueness per scene.

Since:

v4.5.0

See Also:

OBS WebSocket Documentation