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

Class SetTextGDIPlusProperties.Builder

java.lang.Object

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

nl.harm27.obs.websocket.api.requests.sources.SetTextGDIPlusProperties.Builder

Enclosing class:

SetTextGDIPlusProperties

public static class SetTextGDIPlusProperties.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
SetTextGDIPlusProperties.Request	batchMessage()	Batch the message to the OBS Studio instance.
Optional<String>	getAlign()	Text Alignment ("left", "center", "right").
Optional<Integer>	getBkColor()	Background color.
Optional<Integer>	getBkOpacity()	Background opacity (0-100).
Optional<Integer>	getChatlogLines()	Chat log lines.
Optional<Integer>	getColor()	Text color.
Optional<Integer>	getExtentsCx()	Extents cx.
Optional<Integer>	getExtentsCy()	Extents cy.
Optional<String>	getFile()	File path name.
Optional<SetTextGDIPlusProperties.Font>	getFont()	Holds data for the font.
Optional<Integer>	getGradientColor()	Gradient color.
Optional<Float>	getGradientDir()	Gradient direction.
Optional<Integer>	getGradientOpacity()	Gradient opacity (0-100).
Optional<Integer>	getOutlineColor()	Outline color.
Optional<Integer>	getOutlineOpacity()	Outline opacity (0-100).
Optional<Integer>	getOutlineSize()	Outline size.
String	getSource()	Name of the source.
Optional<String>	getText()	Text content to be displayed.
Optional<String>	getValign()	Text vertical alignment ("top", "center", "bottom").
Optional<Boolean>	isChatlog()	Chat log.
Optional<Boolean>	isExtents()	Extents wrap.
Optional<Boolean>	isGradient()	Gradient enabled.
Optional<Boolean>	isOutline()	Outline.
Optional<Boolean>	isReadFromFile()	Read text from the specified file.
Optional<Boolean>	isRender()	Visibility of the scene item.
Optional<Boolean>	isVertical()	Vertical text enabled.
void	sendMessage(Consumer<SetTextGDIPlusProperties.Response> consumer)	Send the message to the OBS Studio instance.
void	setAlign(String align)	Text Alignment ("left", "center", "right").
void	setBkColor(int bkColor)	Background color.
void	setBkOpacity(int bkOpacity)	Background opacity (0-100).
void	setChatlog(boolean chatlog)	Chat log.
void	setChatlogLines(int chatlogLines)	Chat log lines.
void	setColor(int color)	Text color.
void	setExtents(boolean extents)	Extents wrap.
void	setExtentsCx(int extentsCx)	Extents cx.
void	setExtentsCy(int extentsCy)	Extents cy.
void	setFile(String file)	File path name.
void	setFont(SetTextGDIPlusProperties.Font font)	Holds data for the font.
void	setGradient(boolean gradient)	Gradient enabled.
void	setGradientColor(int gradientColor)	Gradient color.
void	setGradientDir(float gradientDir)	Gradient direction.
void	setGradientOpacity(int gradientOpacity)	Gradient opacity (0-100).
void	setOutline(boolean outline)	Outline.
void	setOutlineColor(int outlineColor)	Outline color.
void	setOutlineOpacity(int outlineOpacity)	Outline opacity (0-100).
void	setOutlineSize(int outlineSize)	Outline size.
void	setReadFromFile(boolean readFromFile)	Read text from the specified file.
void	setRender(boolean render)	Visibility of the scene item.
void	setSource(String source)	Name of the source.
void	setText(String text)	Text content to be displayed.
void	setValign(String valign)	Text vertical alignment ("top", "center", "bottom").
void	setVertical(boolean vertical)	Vertical text enabled.

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

getSource

public String getSource()

Name of the source.

setSource

public void setSource(String source)

Name of the source.

getAlign

public Optional<String> getAlign()

Text Alignment ("left", "center", "right").

setAlign

public void setAlign(String align)

Text Alignment ("left", "center", "right").

getBkColor

public Optional<Integer> getBkColor()

Background color.

setBkColor

public void setBkColor(int bkColor)

Background color.

getBkOpacity

public Optional<Integer> getBkOpacity()

Background opacity (0-100).

setBkOpacity

public void setBkOpacity(int bkOpacity)

Background opacity (0-100).

isChatlog

public Optional<Boolean> isChatlog()

Chat log.

setChatlog

public void setChatlog(boolean chatlog)

Chat log.

getChatlogLines

public Optional<Integer> getChatlogLines()

Chat log lines.

setChatlogLines

public void setChatlogLines(int chatlogLines)

Chat log lines.

getColor

public Optional<Integer> getColor()

Text color.

setColor

public void setColor(int color)

Text color.

isExtents

public Optional<Boolean> isExtents()

Extents wrap.

setExtents

public void setExtents(boolean extents)

Extents wrap.

getExtentsCx

public Optional<Integer> getExtentsCx()

Extents cx.

setExtentsCx

public void setExtentsCx(int extentsCx)

Extents cx.

getExtentsCy

public Optional<Integer> getExtentsCy()

Extents cy.

setExtentsCy

public void setExtentsCy(int extentsCy)

Extents cy.

getFile

public Optional<String> getFile()

File path name.

setFile

public void setFile(String file)

File path name.

isReadFromFile

public Optional<Boolean> isReadFromFile()

Read text from the specified file.

setReadFromFile

public void setReadFromFile(boolean readFromFile)

Read text from the specified file.

getFont

public Optional<SetTextGDIPlusProperties.Font> getFont()

Holds data for the font. Ex: `"font": { "face": "Arial", "flags": 0, "size": 150, "style": "" }`

setFont

public void setFont(SetTextGDIPlusProperties.Font font)

Holds data for the font. Ex: `"font": { "face": "Arial", "flags": 0, "size": 150, "style": "" }`

isGradient

public Optional<Boolean> isGradient()

Gradient enabled.

setGradient

public void setGradient(boolean gradient)

Gradient enabled.

getGradientColor

public Optional<Integer> getGradientColor()

Gradient color.

setGradientColor

public void setGradientColor(int gradientColor)

Gradient color.

getGradientDir

public Optional<Float> getGradientDir()

Gradient direction.

setGradientDir

public void setGradientDir(float gradientDir)

Gradient direction.

getGradientOpacity

public Optional<Integer> getGradientOpacity()

Gradient opacity (0-100).

setGradientOpacity

public void setGradientOpacity(int gradientOpacity)

Gradient opacity (0-100).

isOutline

public Optional<Boolean> isOutline()

Outline.

setOutline

public void setOutline(boolean outline)

Outline.

getOutlineColor

public Optional<Integer> getOutlineColor()

Outline color.

setOutlineColor

public void setOutlineColor(int outlineColor)

Outline color.

getOutlineSize

public Optional<Integer> getOutlineSize()

Outline size.

setOutlineSize

public void setOutlineSize(int outlineSize)

Outline size.

getOutlineOpacity

public Optional<Integer> getOutlineOpacity()

Outline opacity (0-100).

setOutlineOpacity

public void setOutlineOpacity(int outlineOpacity)

Outline opacity (0-100).

getText

public Optional<String> getText()

Text content to be displayed.

setText

public void setText(String text)

Text content to be displayed.

getValign

public Optional<String> getValign()

Text vertical alignment ("top", "center", "bottom").

setValign

public void setValign(String valign)

Text vertical alignment ("top", "center", "bottom").

isVertical

public Optional<Boolean> isVertical()

Vertical text enabled.

setVertical

public void setVertical(boolean vertical)

Vertical text enabled.

isRender

public Optional<Boolean> isRender()

Visibility of the scene item.

setRender

public void setRender(boolean render)

Visibility of the scene item.

sendMessage

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

Send the message to the OBS Studio instance.

batchMessage

public SetTextGDIPlusProperties.Request batchMessage()

Batch the message to the OBS Studio instance.