net.twasi.obsremotejava

Class OBSRemoteController

java.lang.Object

net.twasi.obsremotejava.OBSRemoteController

public class OBSRemoteController
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
OBSRemoteController(java.lang.String address, boolean debug)
OBSRemoteController(java.lang.String address, boolean debug, java.lang.String password)
OBSRemoteController(java.lang.String address, boolean debug, java.lang.String password, boolean autoConnect)

Method Summary

Modifier and Type	Method and Description
void	await()
void	changeSceneWithTransition(java.lang.String scene, java.lang.String transition, Callback<SetCurrentSceneResponse> callback)
void	connect()
void	disconnect()
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	getSourceProperties(java.lang.String scene, java.lang.String source, Callback<SetSceneItemPropertiesResponse> 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)
boolean	isFailed()
void	listProfiles(Callback<ListProfilesResponse> callback)
void	registerCloseCallback(CloseCallback closeCallback)
void	registerConnectCallback(Callback<GetVersionResponse> onConnect)
void	registerConnectionFailedCallback(StringCallback onConnectionFailed)
void	registerDisconnectCallback(VoidCallback onDisconnect)
void	registerOnError(ErrorCallback onError)
void	registerRecordingStartedCallback(VoidCallback onRecordingStarted)
void	registerRecordingStoppedCallback(VoidCallback onRecordingStopped)
void	registerReplayStartedCallback(VoidCallback onReplayStarted)
void	registerReplayStartingCallback(VoidCallback onReplayStarting)
void	registerReplayStoppedCallback(VoidCallback onReplayStopped)
void	registerReplayStoppingCallback(VoidCallback onReplayStopping)
void	registerScenesChangedCallback(Callback<ScenesChangedResponse> onScenesChanged)
void	registerSourceFilterVisibilityChangedCallback(Callback<SourceFilterVisibilityChangedResponse> onSourceVisibilityChanged)
void	registerStreamStartedCallback(VoidCallback onRecordingStarted)
void	registerStreamStoppedCallback(VoidCallback onRecordingStopped)
void	registerSwitchScenesCallback(Callback<SwitchScenesResponse> onSwitchScenes)
void	registerSwitchTransitionCallback(Callback<SwitchTransitionResponse> onSwitchTransition)
void	registerTransitionBeginCallback(Callback<TransitionBeginResponse> onTransitionBegin)
void	registerTransitionEndCallback(Callback<TransitionEndResponse> onTransitionEnd)
void	registerTransitionListChangedCallback(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	setSourceVisibility(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

Constructor Detail

OBSRemoteController

public OBSRemoteController(java.lang.String address,
                           boolean debug,
                           java.lang.String password,
                           boolean autoConnect)

OBSRemoteController

public OBSRemoteController(java.lang.String address,
                           boolean debug,
                           java.lang.String password)

OBSRemoteController

public OBSRemoteController(java.lang.String address,
                           boolean debug)

Method Detail

connect

public void connect()

disconnect

public void disconnect()

isFailed

public boolean isFailed()

getScenes

public void getScenes(Callback<GetSceneListResponse> callback)

registerOnError

public void registerOnError(ErrorCallback onError)

registerConnectCallback

public void registerConnectCallback(Callback<GetVersionResponse> onConnect)

registerDisconnectCallback

public void registerDisconnectCallback(VoidCallback onDisconnect)

registerConnectionFailedCallback

public void registerConnectionFailedCallback(StringCallback onConnectionFailed)

registerCloseCallback

public void registerCloseCallback(CloseCallback closeCallback)

registerRecordingStartedCallback

public void registerRecordingStartedCallback(VoidCallback onRecordingStarted)

registerRecordingStoppedCallback

public void registerRecordingStoppedCallback(VoidCallback onRecordingStopped)

registerReplayStartedCallback

public void registerReplayStartedCallback(VoidCallback onReplayStarted)

registerReplayStartingCallback

public void registerReplayStartingCallback(VoidCallback onReplayStarting)

registerReplayStoppedCallback

public void registerReplayStoppedCallback(VoidCallback onReplayStopped)

registerReplayStoppingCallback

public void registerReplayStoppingCallback(VoidCallback onReplayStopping)

registerStreamStartedCallback

public void registerStreamStartedCallback(VoidCallback onRecordingStarted)

registerStreamStoppedCallback

public void registerStreamStoppedCallback(VoidCallback onRecordingStopped)

registerSwitchScenesCallback

public void registerSwitchScenesCallback(Callback<SwitchScenesResponse> onSwitchScenes)

registerScenesChangedCallback

public void registerScenesChangedCallback(Callback<ScenesChangedResponse> onScenesChanged)

registerSwitchTransitionCallback

public void registerSwitchTransitionCallback(Callback<SwitchTransitionResponse> onSwitchTransition)

registerTransitionListChangedCallback

public void registerTransitionListChangedCallback(Callback<TransitionListChangedResponse> onTransitionListChanged)

registerTransitionBeginCallback

public void registerTransitionBeginCallback(Callback<TransitionBeginResponse> onTransitionBegin)

registerTransitionEndCallback

public void registerTransitionEndCallback(Callback<TransitionEndResponse> onTransitionEnd)

registerSourceFilterVisibilityChangedCallback

public void registerSourceFilterVisibilityChangedCallback(Callback<SourceFilterVisibilityChangedResponse> onSourceVisibilityChanged)

await

public void await()
           throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

setCurrentScene

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

setCurrentTransition

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

changeSceneWithTransition

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

setSourceVisibility

public void setSourceVisibility(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)

getSourceProperties

public void getSourceProperties(java.lang.String scene,
                                java.lang.String source,
                                Callback<SetSceneItemPropertiesResponse> 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)

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)

getStreamingStatus

public void getStreamingStatus(Callback<GetStreamingStatusResponse> callback)

startStreaming

public void startStreaming(Callback<StartStreamingResponse> callback)

stopStreaming

public void stopStreaming(Callback<StopStreamingResponse> callback)

startRecording

public void startRecording(Callback<StartRecordingResponse> callback)

stopRecording

public void stopRecording(Callback<StopRecordingResponse> 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)

getStudioModeEnabled

public void getStudioModeEnabled(Callback<GetStudioModeEnabledResponse> callback)

setStudioModeEnabled

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

startReplayBuffer

public void startReplayBuffer(Callback<StartReplayBufferResponse> callback)

stopReplayBuffer

public void stopReplayBuffer(Callback<StopReplayBufferResponse> callback)

saveReplayBuffer

public void saveReplayBuffer(Callback<SaveReplayBufferResponse> callback)