net.twasi.obsremotejava

Class OBSCommunicator

java.lang.Object

net.twasi.obsremotejava.OBSCommunicator

@WebSocket(maxTextMessageSize=65536,
           maxIdleTime=360000000)
public class OBSCommunicator
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,Class>	messageTypes

Constructor Summary

Constructors

Constructor and Description
OBSCommunicator(boolean debug)
OBSCommunicator(boolean debug, String password)

Method Summary

Modifier and Type	Method and Description
void	await()
boolean	awaitClose(int duration, TimeUnit unit)
void	getCurrentProfile(Callback callback)
void	getCurrentScene(Callback callback)
void	getPreviewScene(Callback callback)
void	getSceneItemProperties(String scene, String source, Callback callback)
void	getScenes(Callback callback)
void	getSourceSettings(String sourceName, Callback callback)
void	getStreamingStatus(Callback callback)
void	getStudioModeEnabled(Callback callback)
void	getTransitionDuration(Callback callback)
void	getTransitionList(Callback callback)
void	getVolume(String source, Callback callback)
void	listProfiles(Callback callback)
void	onClose(int statusCode, String reason)
void	onConnect(org.eclipse.jetty.websocket.api.Session session)
void	onMessage(String msg)
void	registerOnConnect(Callback onConnect)
void	registerOnConnectionFailed(StringCallback onConnectionFailed)
void	registerOnDisconnect(Callback onDisconnect)
void	registerOnError(ErrorCallback onError)
void	registerOnReplayStarted(Callback onReplayStarted)
void	registerOnReplayStarting(Callback onReplayStarting)
void	registerOnReplayStopped(Callback onReplayStopped)
void	registerOnReplayStopping(Callback onReplayStopping)
void	registerOnScenesChanged(Callback onScenesChanged)
void	registerOnSwitchScenes(Callback onSwitchScenes)
void	registerOnTransitionBegin(Callback onTransitionBegin)
void	registerOnTransitionEnd(Callback onTransitionEnd)
void	saveReplayBuffer(Callback callback)
void	setCurrentProfile(String profile, Callback callback)
void	setCurrentScene(String scene, Callback callback)
void	setCurrentTransition(String transition, Callback callback)
void	setMute(String source, boolean mute, Callback callback)
void	setPreviewScene(String name, Callback callback)
void	setSourceSettings(String sourceName, Map<String,Object> settings, Callback callback)
void	setSourceVisiblity(String scene, String source, boolean visibility, Callback callback)
void	setStudioModeEnabled(boolean enabled, Callback callback)
void	setTransitionDuration(int duration, Callback callback)
void	setVolume(String source, double volume, Callback callback)
void	startReplayBuffer(Callback callback)
void	startStreaming(Callback callback)
void	stopReplayBuffer(Callback callback)
void	stopStreaming(Callback callback)
void	transitionToProgram(String transitionName, int duration, Callback callback)

Methods inherited from class java.lang.Object

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

Field Detail

messageTypes

public final Map<String,Class> messageTypes

Constructor Detail

OBSCommunicator

public OBSCommunicator(boolean debug,
                       String password)

OBSCommunicator

public OBSCommunicator(boolean debug)

Method Detail

awaitClose

public boolean awaitClose(int duration,
                          TimeUnit unit)
                   throws InterruptedException

Throws:

InterruptedException

await

public void await()
           throws InterruptedException

Throws:

InterruptedException

onClose

@OnWebSocketClose
public void onClose(int statusCode,
                                       String reason)

onConnect

@OnWebSocketConnect
public void onConnect(org.eclipse.jetty.websocket.api.Session session)

onMessage

@OnWebSocketMessage
public void onMessage(String msg)

registerOnError

public void registerOnError(ErrorCallback onError)

registerOnConnect

public void registerOnConnect(Callback onConnect)

registerOnDisconnect

public void registerOnDisconnect(Callback onDisconnect)

registerOnConnectionFailed

public void registerOnConnectionFailed(StringCallback onConnectionFailed)

registerOnReplayStarted

public void registerOnReplayStarted(Callback onReplayStarted)

registerOnReplayStarting

public void registerOnReplayStarting(Callback onReplayStarting)

registerOnReplayStopped

public void registerOnReplayStopped(Callback onReplayStopped)

registerOnReplayStopping

public void registerOnReplayStopping(Callback onReplayStopping)

registerOnSwitchScenes

public void registerOnSwitchScenes(Callback onSwitchScenes)

registerOnScenesChanged

public void registerOnScenesChanged(Callback onScenesChanged)

registerOnTransitionBegin

public void registerOnTransitionBegin(Callback onTransitionBegin)

registerOnTransitionEnd

public void registerOnTransitionEnd(Callback onTransitionEnd)

getScenes

public void getScenes(Callback callback)

setCurrentScene

public void setCurrentScene(String scene,
                            Callback callback)

setCurrentTransition

public void setCurrentTransition(String transition,
                                 Callback callback)

setSourceVisiblity

public void setSourceVisiblity(String scene,
                               String source,
                               boolean visibility,
                               Callback callback)

getSceneItemProperties

public void getSceneItemProperties(String scene,
                                   String source,
                                   Callback callback)

getTransitionList

public void getTransitionList(Callback callback)

transitionToProgram

public void transitionToProgram(String transitionName,
                                int duration,
                                Callback callback)

getSourceSettings

public void getSourceSettings(String sourceName,
                              Callback callback)

setSourceSettings

public void setSourceSettings(String sourceName,
                              Map<String,Object> settings,
                              Callback callback)

getStreamingStatus

public void getStreamingStatus(Callback callback)

startStreaming

public void startStreaming(Callback callback)

stopStreaming

public void stopStreaming(Callback callback)

listProfiles

public void listProfiles(Callback callback)

getCurrentProfile

public void getCurrentProfile(Callback callback)

setCurrentProfile

public void setCurrentProfile(String profile,
                              Callback callback)

getCurrentScene

public void getCurrentScene(Callback callback)

getVolume

public void getVolume(String source,
                      Callback callback)

setVolume

public void setVolume(String source,
                      double volume,
                      Callback callback)

setMute

public void setMute(String source,
                    boolean mute,
                    Callback callback)

getPreviewScene

public void getPreviewScene(Callback callback)

setPreviewScene

public void setPreviewScene(String name,
                            Callback callback)

getTransitionDuration

public void getTransitionDuration(Callback callback)

setTransitionDuration

public void setTransitionDuration(int duration,
                                  Callback callback)

startReplayBuffer

public void startReplayBuffer(Callback callback)

stopReplayBuffer

public void stopReplayBuffer(Callback callback)

saveReplayBuffer

public void saveReplayBuffer(Callback callback)

getStudioModeEnabled

public void getStudioModeEnabled(Callback callback)

setStudioModeEnabled

public void setStudioModeEnabled(boolean enabled,
                                 Callback callback)