Package nl.harm27.obs.websocket.sender

Class TransitionsRequestSender

java.lang.Object

nl.harm27.obs.websocket.sender.RequestSender

nl.harm27.obs.websocket.sender.TransitionsRequestSender

public class TransitionsRequestSender
extends RequestSender

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GetCurrentTransition.Builder	getCurrentTransition()	Get the name of the currently selected transition in the frontend's dropdown menu.
GetTransitionDuration.Builder	getTransitionDuration()	Get the duration of the currently selected transition if supported.
GetTransitionList.Builder	getTransitionList()	List of all transitions available in the frontend's dropdown menu.
GetTransitionPosition.Builder	getTransitionPosition()	Get the position of the current transition.
GetTransitionSettings.Builder	getTransitionSettings()	Get the current settings of a transition
ReleaseTBar.Builder	releaseTBar()	Release the T-Bar (like a user releasing their mouse button after moving it).
SetCurrentTransition.Builder	setCurrentTransition()	Set the active transition.
SetTBarPosition.Builder	setTBarPosition()	If your code needs to perform multiple successive T-Bar moves (e.g.
SetTransitionDuration.Builder	setTransitionDuration()	Set the duration of the currently selected transition if supported.
SetTransitionSettings.Builder	setTransitionSettings()	Change the current settings of a transition

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

TransitionsRequestSender

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

Method Detail

getTransitionList

public GetTransitionList.Builder getTransitionList()

List of all transitions available in the frontend's dropdown menu.

Since:

4.1.0

See Also:

OBS WebSocket Documentation

getCurrentTransition

public GetCurrentTransition.Builder getCurrentTransition()

Get the name of the currently selected transition in the frontend's dropdown menu.

Since:

0.3

See Also:

OBS WebSocket Documentation

setCurrentTransition

public SetCurrentTransition.Builder setCurrentTransition()

Set the active transition.

Since:

0.3

See Also:

OBS WebSocket Documentation

setTransitionDuration

public SetTransitionDuration.Builder setTransitionDuration()

Set the duration of the currently selected transition if supported.

Since:

4.0.0

See Also:

OBS WebSocket Documentation

getTransitionDuration

public GetTransitionDuration.Builder getTransitionDuration()

Get the duration of the currently selected transition if supported.

Since:

4.1.0

See Also:

OBS WebSocket Documentation

getTransitionPosition

public GetTransitionPosition.Builder getTransitionPosition()

Get the position of the current transition.

Since:

4.9.0

See Also:

OBS WebSocket Documentation

getTransitionSettings

public GetTransitionSettings.Builder getTransitionSettings()

Get the current settings of a transition

Since:

4.9.0

See Also:

OBS WebSocket Documentation

setTransitionSettings

public SetTransitionSettings.Builder setTransitionSettings()

Change the current settings of a transition

Since:

4.9.0

See Also:

OBS WebSocket Documentation

releaseTBar

public ReleaseTBar.Builder releaseTBar()

Release the T-Bar (like a user releasing their mouse button after moving it). *YOU MUST CALL THIS if you called `SetTBarPosition` with the `release` parameter set to `false`.*

Since:

4.9.0

See Also:

OBS WebSocket Documentation

setTBarPosition

public SetTBarPosition.Builder setTBarPosition()

If your code needs to perform multiple successive T-Bar moves (e.g. : in an animation, or in response to a user moving a T-Bar control in your User Interface), set `release` to false and call `ReleaseTBar` later once the animation/interaction is over.

Since:

4.9.0

See Also:

OBS WebSocket Documentation