Package nl.harm27.obs.websocket.api.base

Class BaseResponse

java.lang.Object

nl.harm27.obs.websocket.api.base.BaseResponse

Direct Known Subclasses:

AddFilterToSource.Response, AddSceneItem.Response, Authenticate.Response, BroadcastCustomMessage.Response, CreateScene.Response, CreateSource.Response, DeleteSceneItem.Response, DisableStudioMode.Response, DuplicateSceneItem.Response, EnableStudioMode.Response, ExecuteBatch.Response, GetAudioActive.Response, GetAudioMonitorType.Response, GetAudioTracks.Response, GetAuthRequired.Response, GetBrowserSourceProperties.Response, GetCurrentProfile.Response, GetCurrentScene.Response, GetCurrentSceneCollection.Response, GetCurrentTransition.Response, GetFilenameFormatting.Response, GetMediaDuration.Response, GetMediaSourcesList.Response, GetMediaState.Response, GetMediaTime.Response, GetMute.Response, GetOutputInfo.Response, GetPreviewScene.Response, GetRecordingFolder.Response, GetRecordingStatus.Response, GetReplayBufferStatus.Response, GetSceneItemList.Response, GetSceneItemProperties.Response, GetSceneList.Response, GetSceneTransitionOverride.Response, GetSourceActive.Response, GetSourceDefaultSettings.Response, GetSourceFilterInfo.Response, GetSourceFilters.Response, GetSourceSettings.Response, GetSourcesList.Response, GetSourceTypesList.Response, GetSpecialSources.Response, GetStats.Response, GetStreamingStatus.Response, GetStreamSettings.Response, GetStudioModeStatus.Response, GetSyncOffset.Response, GetTextFreetype2Properties.Response, GetTextGDIPlusProperties.Response, GetTransitionDuration.Response, GetTransitionList.Response, GetTransitionPosition.Response, GetTransitionSettings.Response, GetVersion.Response, GetVideoInfo.Response, GetVirtualCamStatus.Response, GetVolume.Response, ListOutputs.Response, ListProfiles.Response, ListSceneCollections.Response, MoveSourceFilter.Response, NextMedia.Response, OpenProjector.Response, PauseRecording.Response, PlayPauseMedia.Response, PreviousMedia.Response, RefreshBrowserSource.Response, ReleaseTBar.Response, RemoveFilterFromSource.Response, RemoveSceneTransitionOverride.Response, ReorderSceneItems.Response, ReorderSourceFilter.Response, ResetSceneItem.Response, RestartMedia.Response, ResumeRecording.Response, SaveReplayBuffer.Response, SaveStreamSettings.Response, ScrubMedia.Response, SendCaptions.Response, SetAudioMonitorType.Response, SetAudioTracks.Response, SetBrowserSourceProperties.Response, SetCurrentProfile.Response, SetCurrentScene.Response, SetCurrentSceneCollection.Response, SetCurrentTransition.Response, SetFilenameFormatting.Response, SetHeartbeat.Response, SetMediaTime.Response, SetMute.Response, SetPreviewScene.Response, SetRecordingFolder.Response, SetSceneItemCrop.Response, SetSceneItemPosition.Response, SetSceneItemProperties.Response, SetSceneItemRender.Response, SetSceneItemTransform.Response, SetSceneTransitionOverride.Response, SetSourceFilterSettings.Response, SetSourceFilterVisibility.Response, SetSourceName.Response, SetSourceSettings.Response, SetStreamSettings.Response, SetSyncOffset.Response, SetTBarPosition.Response, SetTextFreetype2Properties.Response, SetTextGDIPlusProperties.Response, SetTransitionDuration.Response, SetTransitionSettings.Response, SetVolume.Response, Sleep.Response, StartOutput.Response, StartRecording.Response, StartReplayBuffer.Response, StartStopRecording.Response, StartStopReplayBuffer.Response, StartStopStreaming.Response, StartStopVirtualCam.Response, StartStreaming.Response, StartVirtualCam.Response, StopMedia.Response, StopOutput.Response, StopRecording.Response, StopReplayBuffer.Response, StopStreaming.Response, StopVirtualCam.Response, TakeSourceScreenshot.Response, ToggleMute.Response, ToggleStudioMode.Response, TransitionToProgram.Response, TriggerHotkeyByName.Response, TriggerHotkeyBySequence.Response

public abstract class BaseResponse
extends Object

Once a request is sent, the server will return a response.

See Also:

OBS WebSocket Documentation

Constructor Summary

Constructors

Constructor	Description
BaseResponse()

Method Summary

Modifier and Type	Method	Description
Optional<String>	getError()	An error message accompanying an error status.
String	getMessageId()	The client defined identifier specified in the request.
Status	getStatus()	Response status, will be one of the following: ok, error

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseResponse

public BaseResponse()

Method Detail

getMessageId

public String getMessageId()

The client defined identifier specified in the request.

getStatus

public Status getStatus()

Response status, will be one of the following: ok, error

getError

public Optional<String> getError()

An error message accompanying an error status.