Class SceneItem
- java.lang.Object
-
- nl.harm27.obswebsocket.api.complex.SceneItem
-
public class SceneItem extends Object
- See Also:
- OBS WebSocket Documentation
-
-
Constructor Summary
Constructors Constructor Description SceneItem()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NumbergetCx()NumbergetCy()Optional<List<SceneItem>>getGroupChildren()List of children (if this item is a group) (optional)intgetId()Scene item ID.StringgetName()The name of this Scene Item.Optional<String>getParentGroupName()Name of the item's parent (if this item belongs to a group) (optional)booleangetRender()Whether or not this Scene Item is set to "visible".NumbergetSourceCx()NumbergetSourceCy()SourceTypegetType()Source type.NumbergetVolume()NumbergetX()NumbergetY()booleanisLocked()Whether or not this Scene Item is locked and can't be moved aroundvoidsetId(int id)Set the scene item ID.voidsetName(String name)Set the name of a scene item.
-
-
-
Method Detail
-
getCy
public Number getCy()
-
getCx
public Number getCx()
-
getName
public String getName()
The name of this Scene Item.
-
setName
public void setName(String name)
Set the name of a scene item.
-
getId
public int getId()
Scene item ID.
-
setId
public void setId(int id)
Set the scene item ID.
-
getRender
public boolean getRender()
Whether or not this Scene Item is set to "visible".
-
isLocked
public boolean isLocked()
Whether or not this Scene Item is locked and can't be moved around
-
getSourceCx
public Number getSourceCx()
-
getSourceCy
public Number getSourceCy()
-
getType
public SourceType getType()
Source type. Value is one of the following: "input", "filter", "transition", "scene" or "unknown"
-
getVolume
public Number getVolume()
-
getX
public Number getX()
-
getY
public Number getY()
-
getParentGroupName
public Optional<String> getParentGroupName()
Name of the item's parent (if this item belongs to a group) (optional)
-
-