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

Class SetBrowserSourceProperties.Builder

java.lang.Object

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

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

Enclosing class:

SetBrowserSourceProperties

public static class SetBrowserSourceProperties.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
SetBrowserSourceProperties.Request	batchMessage()	Batch the message to the OBS Studio instance.
Optional<String>	getCss()	CSS to inject.
Optional<Integer>	getFps()	Framerate.
Optional<Integer>	getHeight()	Height.
Optional<String>	getLocalFile()	file path.
String	getSource()	Name of the source.
Optional<String>	getUrl()	Url.
Optional<Integer>	getWidth()	Width.
Optional<Boolean>	isIsLocalFile()	Indicates that a local file is in use.
Optional<Boolean>	isRender()	Visibility of the scene item.
Optional<Boolean>	isShutdown()	Indicates whether the source should be shutdown when not visible.
void	sendMessage(Consumer<SetBrowserSourceProperties.Response> consumer)	Send the message to the OBS Studio instance.
void	setCss(String css)	CSS to inject.
void	setFps(int fps)	Framerate.
void	setHeight(int height)	Height.
void	setIsLocalFile(boolean isLocalFile)	Indicates that a local file is in use.
void	setLocalFile(String localFile)	file path.
void	setRender(boolean render)	Visibility of the scene item.
void	setShutdown(boolean shutdown)	Indicates whether the source should be shutdown when not visible.
void	setSource(String source)	Name of the source.
void	setUrl(String url)	Url.
void	setWidth(int width)	Width.

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.

isIsLocalFile

public Optional<Boolean> isIsLocalFile()

Indicates that a local file is in use.

setIsLocalFile

public void setIsLocalFile(boolean isLocalFile)

Indicates that a local file is in use.

getLocalFile

public Optional<String> getLocalFile()

file path.

setLocalFile

public void setLocalFile(String localFile)

file path.

getUrl

public Optional<String> getUrl()

Url.

setUrl

public void setUrl(String url)

Url.

getCss

public Optional<String> getCss()

CSS to inject.

setCss

public void setCss(String css)

CSS to inject.

getWidth

public Optional<Integer> getWidth()

Width.

setWidth

public void setWidth(int width)

Width.

getHeight

public Optional<Integer> getHeight()

Height.

setHeight

public void setHeight(int height)

Height.

getFps

public Optional<Integer> getFps()

Framerate.

setFps

public void setFps(int fps)

Framerate.

isShutdown

public Optional<Boolean> isShutdown()

Indicates whether the source should be shutdown when not visible.

setShutdown

public void setShutdown(boolean shutdown)

Indicates whether the source should be shutdown when not visible.

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<SetBrowserSourceProperties.Response> consumer)

Send the message to the OBS Studio instance.

batchMessage

public SetBrowserSourceProperties.Request batchMessage()

Batch the message to the OBS Studio instance.