net.twasi.obsremotejava

Class OBSCommunicator

java.lang.Object

net.twasi.obsremotejava.OBSCommunicator

@WebSocket(maxIdleTime=360000000)
public class OBSCommunicator
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,java.lang.Class>	messageTypes

Constructor Summary

Constructors

Constructor and Description
OBSCommunicator(boolean debug)
OBSCommunicator(boolean debug, java.lang.String password)

Method Summary

Modifier and Type	Method and Description
void	await()
boolean	awaitClose(int duration, java.util.concurrent.TimeUnit unit)
void	getCurrentProfile(Callback<GetCurrentProfileResponse> callback)
void	getCurrentScene(Callback<GetCurrentSceneResponse> callback)
void	getPreviewScene(Callback<GetPreviewSceneResponse> callback)
void	getSceneItemProperties(java.lang.String scene, java.lang.String source, Callback<SetSceneItemPropertiesResponse> callback)
void	getScenes(Callback<GetSceneListResponse> callback)
void	getSourceFilterInfo(java.lang.String sourceName, java.lang.String filterName, Callback<GetSourceFilterInfoResponse> callback)
void	getSourceFilters(java.lang.String sourceName, Callback<GetSourceFiltersResponse> callback)
void	getSourceSettings(java.lang.String sourceName, Callback<GetSourceSettingsResponse> callback)
void	getStreamingStatus(Callback<GetStreamingStatusResponse> callback)
void	getStudioModeEnabled(Callback<GetStudioModeEnabledResponse> callback)
void	getTransitionDuration(Callback<GetTransitionDurationResponse> callback)
void	getTransitionList(Callback<GetTransitionListResponse> callback)
void	getVolume(java.lang.String source, Callback<GetVolumeResponse> callback)
void	listProfiles(Callback<ListProfilesResponse> callback)
void	onClose(int statusCode, java.lang.String reason)
void	onConnect(org.eclipse.jetty.websocket.api.Session session)
void	onError(org.eclipse.jetty.websocket.api.Session session, java.lang.Throwable throwable)
void	onMessage(java.lang.String msg)
void	registerOnClose(CloseCallback closeCallback)
void	registerOnConnect(Callback<GetVersionResponse> onConnect)
void	registerOnConnectionFailed(StringCallback onConnectionFailed)
void	registerOnDisconnect(VoidCallback onDisconnect)
void	registerOnError(ErrorCallback onError)
void	registerOnRecordingStarted(VoidCallback onRecordingStarted)
void	registerOnRecordingStopped(VoidCallback onRecordingStopped)
void	registerOnReplayStarted(VoidCallback onReplayStarted)
void	registerOnReplayStarting(VoidCallback onReplayStarting)
void	registerOnReplayStopped(VoidCallback onReplayStopped)
void	registerOnReplayStopping(VoidCallback onReplayStopping)
void	registerOnScenesChanged(Callback<ScenesChangedResponse> onScenesChanged)
void	registerOnSourceFilterVisibilityChanged(Callback<SourceFilterVisibilityChangedResponse> onSourceFilterVisibilityChanged)
void	registerOnStreamStarted(VoidCallback onStreamStarted)
void	registerOnStreamStopped(VoidCallback onStreamStopped)
void	registerOnSwitchScenes(Callback<SwitchScenesResponse> onSwitchScenes)
void	registerOnSwitchTransition(Callback<SwitchTransitionResponse> onSwitchTransition)
void	registerOnTransitionBegin(Callback<TransitionBeginResponse> onTransitionBegin)
void	registerOnTransitionEnd(Callback<TransitionEndResponse> onTransitionEnd)
void	registerOnTransitionListChanged(Callback<TransitionListChangedResponse> onTransitionListChanged)
void	saveReplayBuffer(Callback<SaveReplayBufferResponse> callback)
void	setCurrentProfile(java.lang.String profile, Callback<SetCurrentProfileResponse> callback)
void	setCurrentScene(java.lang.String scene, Callback<SetCurrentSceneResponse> callback)
void	setCurrentTransition(java.lang.String transition, Callback<SetCurrentTransitionResponse> callback)
void	setMute(java.lang.String source, boolean mute, Callback<SetMuteResponse> callback)
void	setPreviewScene(java.lang.String name, Callback<SetPreviewSceneResponse> callback)
void	setSourceFilterVisibility(java.lang.String sourceName, java.lang.String filterName, boolean filterEnabled, Callback<SetSourceFilterVisibilityResponse> callback)
void	setSourceSettings(java.lang.String sourceName, java.util.Map<java.lang.String,java.lang.Object> settings, Callback<SetSourceSettingsResponse> callback)
void	setSourceVisiblity(java.lang.String scene, java.lang.String source, boolean visibility, Callback<SetSceneItemPropertiesResponse> callback)
void	setStudioModeEnabled(boolean enabled, Callback<SetStudioModeEnabledResponse> callback)
void	setTransitionDuration(int duration, Callback<SetTransitionDurationResponse> callback)
void	setVolume(java.lang.String source, double volume, Callback<SetVolumeResponse> callback)
void	startRecording(Callback<StartRecordingResponse> callback)
void	startReplayBuffer(Callback<StartReplayBufferResponse> callback)
void	startStreaming(Callback<StartStreamingResponse> callback)
void	stopRecording(Callback<StopRecordingResponse> callback)
void	stopReplayBuffer(Callback<StopReplayBufferResponse> callback)
void	stopStreaming(Callback<StopStreamingResponse> callback)
void	transitionToProgram(java.lang.String transitionName, int duration, Callback<TransitionToProgramResponse> callback)

Methods inherited from class java.lang.Object

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

Field Detail

messageTypes

public final java.util.Map<java.lang.String,java.lang.Class> messageTypes

Constructor Detail

OBSCommunicator

public OBSCommunicator(boolean debug,
                       java.lang.String password)

OBSCommunicator

public OBSCommunicator(boolean debug)

Method Detail

awaitClose

public boolean awaitClose(int duration,
                          java.util.concurrent.TimeUnit unit)
                   throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

await

public void await()
           throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

onError

@OnWebSocketError
public void onError(org.eclipse.jetty.websocket.api.Session session,
                                      java.lang.Throwable throwable)

onClose

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

onConnect

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

onMessage

@OnWebSocketMessage
public void onMessage(java.lang.String msg)

registerOnError

public void registerOnError(ErrorCallback onError)

registerOnConnect

public void registerOnConnect(Callback<GetVersionResponse> onConnect)

registerOnDisconnect

public void registerOnDisconnect(VoidCallback onDisconnect)

registerOnClose

public void registerOnClose(CloseCallback closeCallback)

registerOnConnectionFailed

public void registerOnConnectionFailed(StringCallback onConnectionFailed)

registerOnReplayStarted

public void registerOnReplayStarted(VoidCallback onReplayStarted)

registerOnReplayStarting

public void registerOnReplayStarting(VoidCallback onReplayStarting)

registerOnReplayStopped

public void registerOnReplayStopped(VoidCallback onReplayStopped)

registerOnReplayStopping

public void registerOnReplayStopping(VoidCallback onReplayStopping)

registerOnSwitchScenes

public void registerOnSwitchScenes(Callback<SwitchScenesResponse> onSwitchScenes)

registerOnScenesChanged

public void registerOnScenesChanged(Callback<ScenesChangedResponse> onScenesChanged)

registerOnSourceFilterVisibilityChanged

public void registerOnSourceFilterVisibilityChanged(Callback<SourceFilterVisibilityChangedResponse> onSourceFilterVisibilityChanged)

registerOnSwitchTransition

public void registerOnSwitchTransition(Callback<SwitchTransitionResponse> onSwitchTransition)

registerOnTransitionListChanged

public void registerOnTransitionListChanged(Callback<TransitionListChangedResponse> onTransitionListChanged)

registerOnTransitionBegin

public void registerOnTransitionBegin(Callback<TransitionBeginResponse> onTransitionBegin)

registerOnTransitionEnd

public void registerOnTransitionEnd(Callback<TransitionEndResponse> onTransitionEnd)

registerOnRecordingStarted

public void registerOnRecordingStarted(VoidCallback onRecordingStarted)

registerOnRecordingStopped

public void registerOnRecordingStopped(VoidCallback onRecordingStopped)

registerOnStreamStarted

public void registerOnStreamStarted(VoidCallback onStreamStarted)

registerOnStreamStopped

public void registerOnStreamStopped(VoidCallback onStreamStopped)

getScenes

public void getScenes(Callback<GetSceneListResponse> callback)

setCurrentScene

public void setCurrentScene(java.lang.String scene,
                            Callback<SetCurrentSceneResponse> callback)

setCurrentTransition

public void setCurrentTransition(java.lang.String transition,
                                 Callback<SetCurrentTransitionResponse> callback)

setSourceVisiblity

public void setSourceVisiblity(java.lang.String scene,
                               java.lang.String source,
                               boolean visibility,
                               Callback<SetSceneItemPropertiesResponse> callback)

getSceneItemProperties

public void getSceneItemProperties(java.lang.String scene,
                                   java.lang.String source,
                                   Callback<SetSceneItemPropertiesResponse> callback)

getTransitionList

public void getTransitionList(Callback<GetTransitionListResponse> callback)

transitionToProgram

public void transitionToProgram(java.lang.String transitionName,
                                int duration,
                                Callback<TransitionToProgramResponse> callback)

getSourceSettings

public void getSourceSettings(java.lang.String sourceName,
                              Callback<GetSourceSettingsResponse> callback)

setSourceSettings

public void setSourceSettings(java.lang.String sourceName,
                              java.util.Map<java.lang.String,java.lang.Object> settings,
                              Callback<SetSourceSettingsResponse> callback)

getSourceFilters

public void getSourceFilters(java.lang.String sourceName,
                             Callback<GetSourceFiltersResponse> callback)

getSourceFilterInfo

public void getSourceFilterInfo(java.lang.String sourceName,
                                java.lang.String filterName,
                                Callback<GetSourceFilterInfoResponse> callback)

setSourceFilterVisibility

public void setSourceFilterVisibility(java.lang.String sourceName,
                                      java.lang.String filterName,
                                      boolean filterEnabled,
                                      Callback<SetSourceFilterVisibilityResponse> callback)

startRecording

public void startRecording(Callback<StartRecordingResponse> callback)

stopRecording

public void stopRecording(Callback<StopRecordingResponse> callback)

getStreamingStatus

public void getStreamingStatus(Callback<GetStreamingStatusResponse> callback)

startStreaming

public void startStreaming(Callback<StartStreamingResponse> callback)

stopStreaming

public void stopStreaming(Callback<StopStreamingResponse> callback)

listProfiles

public void listProfiles(Callback<ListProfilesResponse> callback)

getCurrentProfile

public void getCurrentProfile(Callback<GetCurrentProfileResponse> callback)

setCurrentProfile

public void setCurrentProfile(java.lang.String profile,
                              Callback<SetCurrentProfileResponse> callback)

getCurrentScene

public void getCurrentScene(Callback<GetCurrentSceneResponse> callback)

getVolume

public void getVolume(java.lang.String source,
                      Callback<GetVolumeResponse> callback)

setVolume

public void setVolume(java.lang.String source,
                      double volume,
                      Callback<SetVolumeResponse> callback)

setMute

public void setMute(java.lang.String source,
                    boolean mute,
                    Callback<SetMuteResponse> callback)

getPreviewScene

public void getPreviewScene(Callback<GetPreviewSceneResponse> callback)

setPreviewScene

public void setPreviewScene(java.lang.String name,
                            Callback<SetPreviewSceneResponse> callback)

getTransitionDuration

public void getTransitionDuration(Callback<GetTransitionDurationResponse> callback)

setTransitionDuration

public void setTransitionDuration(int duration,
                                  Callback<SetTransitionDurationResponse> callback)

startReplayBuffer

public void startReplayBuffer(Callback<StartReplayBufferResponse> callback)

stopReplayBuffer

public void stopReplayBuffer(Callback<StopReplayBufferResponse> callback)

saveReplayBuffer

public void saveReplayBuffer(Callback<SaveReplayBufferResponse> callback)

getStudioModeEnabled

public void getStudioModeEnabled(Callback<GetStudioModeEnabledResponse> callback)

setStudioModeEnabled

public void setStudioModeEnabled(boolean enabled,
                                 Callback<SetStudioModeEnabledResponse> callback)