Package nl.harm27.obs.websocket.api.requests.sceneitems

Class SetSceneItemProperties.Builder

java.lang.Object

nl.harm27.obs.websocket.api.base.BaseBuilder

nl.harm27.obs.websocket.api.requests.sceneitems.SetSceneItemProperties.Builder

Enclosing class:

SetSceneItemProperties

public static class SetSceneItemProperties.Builder
extends BaseBuilder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SetSceneItemProperties.Request	batchMessage()	Batch the message to the OBS Studio instance.
SetSceneItemProperties.Bounds	getBounds()
SetSceneItemProperties.Crop	getCrop()
SetSceneItemProperties.Item	getItem()	Scene Item name (if this field is a string) or specification (if it is an object).
SetSceneItemProperties.Position	getPosition()
Optional<Double>	getRotation()	The new clockwise rotation of the item in degrees.
SetSceneItemProperties.Scale	getScale()
Optional<String>	getSceneName()	Name of the scene the source item belongs to.
Optional<Boolean>	isLocked()	The new locked status of the source.
Optional<Boolean>	isVisible()	The new visibility of the source.
void	sendMessage(Consumer<SetSceneItemProperties.Response> consumer)	Send the message to the OBS Studio instance.
void	setBounds(SetSceneItemProperties.Bounds bounds)
void	setCrop(SetSceneItemProperties.Crop crop)
void	setItem(SetSceneItemProperties.Item item)	Scene Item name (if this field is a string) or specification (if it is an object).
void	setLocked(boolean locked)	The new locked status of the source.
void	setPosition(SetSceneItemProperties.Position position)
void	setRotation(double rotation)	The new clockwise rotation of the item in degrees.
void	setScale(SetSceneItemProperties.Scale scale)
void	setSceneName(String sceneName)	Name of the scene the source item belongs to.
void	setVisible(boolean visible)	The new visibility of the source.

Methods inherited from class nl.harm27.obs.websocket.api.base.BaseBuilder

batchMessage, getNewMessageId, sendMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

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

Method Detail

getSceneName

public Optional<String> getSceneName()

Name of the scene the source item belongs to. Defaults to the current scene.

setSceneName

public void setSceneName(String sceneName)

Name of the scene the source item belongs to. Defaults to the current scene.

getItem

public SetSceneItemProperties.Item getItem()

Scene Item name (if this field is a string) or specification (if it is an object).

setItem

public void setItem(SetSceneItemProperties.Item item)

Scene Item name (if this field is a string) or specification (if it is an object).

getPosition

public SetSceneItemProperties.Position getPosition()

setPosition

public void setPosition(SetSceneItemProperties.Position position)

getRotation

public Optional<Double> getRotation()

The new clockwise rotation of the item in degrees.

setRotation

public void setRotation(double rotation)

The new clockwise rotation of the item in degrees.

getScale

public SetSceneItemProperties.Scale getScale()

setScale

public void setScale(SetSceneItemProperties.Scale scale)

getCrop

public SetSceneItemProperties.Crop getCrop()

setCrop

public void setCrop(SetSceneItemProperties.Crop crop)

isVisible

public Optional<Boolean> isVisible()

The new visibility of the source. 'true' shows source, 'false' hides source.

setVisible

public void setVisible(boolean visible)

The new visibility of the source. 'true' shows source, 'false' hides source.

isLocked

public Optional<Boolean> isLocked()

The new locked status of the source. 'true' keeps it in its current position, 'false' allows movement.

setLocked

public void setLocked(boolean locked)

The new locked status of the source. 'true' keeps it in its current position, 'false' allows movement.

getBounds

public SetSceneItemProperties.Bounds getBounds()

setBounds

public void setBounds(SetSceneItemProperties.Bounds bounds)

sendMessage

public void sendMessage(Consumer<SetSceneItemProperties.Response> consumer)

Send the message to the OBS Studio instance.

batchMessage

public SetSceneItemProperties.Request batchMessage()

Batch the message to the OBS Studio instance.