Package nl.harm27.obs.websocket.sender

Class SceneItemsRequestSender

java.lang.Object

nl.harm27.obs.websocket.sender.RequestSender

nl.harm27.obs.websocket.sender.SceneItemsRequestSender

public class SceneItemsRequestSender
extends RequestSender

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AddSceneItem.Builder	addSceneItem()	Creates a scene item in a scene.
DeleteSceneItem.Builder	deleteSceneItem()	Deletes a scene item.
DuplicateSceneItem.Builder	duplicateSceneItem()	Duplicates a scene item.
GetSceneItemList.Builder	getSceneItemList()	Get a list of all scene items in a scene.
GetSceneItemProperties.Builder	getSceneItemProperties()	Gets the scene specific properties of the specified source item.
ResetSceneItem.Builder	resetSceneItem()	Reset a scene item.
SetSceneItemCrop.Builder	setSceneItemCrop()	Deprecated. Since 4.3.0.
SetSceneItemPosition.Builder	setSceneItemPosition()	Deprecated. Since 4.3.0.
SetSceneItemProperties.Builder	setSceneItemProperties()	Sets the scene specific properties of a source.
SetSceneItemRender.Builder	setSceneItemRender()	Show or hide a specified source item in a specified scene.
SetSceneItemTransform.Builder	setSceneItemTransform()	Deprecated. Since 4.3.0.

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

SceneItemsRequestSender

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

Method Detail

getSceneItemList

public GetSceneItemList.Builder getSceneItemList()

Get a list of all scene items in a scene.

Since:

4.9.0

See Also:

OBS WebSocket Documentation

getSceneItemProperties

public GetSceneItemProperties.Builder getSceneItemProperties()

Gets the scene specific properties of the specified source item. Coordinates are relative to the item's parent (the scene or group it belongs to).

Since:

4.3.0

See Also:

OBS WebSocket Documentation

setSceneItemProperties

public SetSceneItemProperties.Builder setSceneItemProperties()

Sets the scene specific properties of a source. Unspecified properties will remain unchanged. Coordinates are relative to the item's parent (the scene or group it belongs to).

Since:

4.3.0

See Also:

OBS WebSocket Documentation

resetSceneItem

public ResetSceneItem.Builder resetSceneItem()

Reset a scene item.

Since:

4.2.0

See Also:

OBS WebSocket Documentation

setSceneItemRender

public SetSceneItemRender.Builder setSceneItemRender()

Show or hide a specified source item in a specified scene.

Since:

0.3

See Also:

OBS WebSocket Documentation

setSceneItemPosition

public SetSceneItemPosition.Builder setSceneItemPosition()

Deprecated.

Since 4.3.0. Prefer the use of SetSceneItemProperties.

Sets the coordinates of a specified source item.

Since:

4.0.0

See Also:

OBS WebSocket Documentation

setSceneItemTransform

public SetSceneItemTransform.Builder setSceneItemTransform()

Deprecated.

Since 4.3.0. Prefer the use of SetSceneItemProperties.

Set the transform of the specified source item.

Since:

4.0.0

See Also:

OBS WebSocket Documentation

setSceneItemCrop

public SetSceneItemCrop.Builder setSceneItemCrop()

Deprecated.

Since 4.3.0. Prefer the use of SetSceneItemProperties.

Sets the crop coordinates of the specified source item.

Since:

4.1.0

See Also:

OBS WebSocket Documentation

deleteSceneItem

public DeleteSceneItem.Builder deleteSceneItem()

Deletes a scene item.

Since:

4.5.0

See Also:

OBS WebSocket Documentation

addSceneItem

public AddSceneItem.Builder addSceneItem()

Creates a scene item in a scene. In other words, this is how you add a source into a scene.

Since:

4.9.0

See Also:

OBS WebSocket Documentation

duplicateSceneItem

public DuplicateSceneItem.Builder duplicateSceneItem()

Duplicates a scene item.

Since:

4.5.0

See Also:

OBS WebSocket Documentation