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

Class BaseRequest

java.lang.Object

nl.harm27.obs.websocket.api.base.BaseRequest

Direct Known Subclasses:

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

public abstract class BaseRequest
extends Object

Requests that are sent by the client.

See Also:

OBS WebSocket Documentation

Constructor Summary

Constructors

Constructor	Description
BaseRequest(RequestType requestType, String messageId)

Method Summary

Modifier and Type	Method	Description
String	getMessageId()	Client defined identifier for the message, will be echoed in the response.
abstract String	getRequestName()	Says what the name is of this class.
RequestType	getRequestType()	Enum constants for names of the request types.
abstract Class<?>	getResponseType()	Response type class to map the response to the correct datatype.
boolean	isAuthenticationRequired()	Says if request needs to wait for authentication.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseRequest

public BaseRequest(RequestType requestType,
                   String messageId)

Method Detail

getRequestType

public RequestType getRequestType()

Enum constants for names of the request types.

getMessageId

public String getMessageId()

Client defined identifier for the message, will be echoed in the response.

getResponseType

public abstract Class<?> getResponseType()

Response type class to map the response to the correct datatype.

getRequestName

public abstract String getRequestName()

Says what the name is of this class.

isAuthenticationRequired

public boolean isAuthenticationRequired()

Says if request needs to wait for authentication.