A B C D E F G H I L M N O P R S T U V 
All Classes All Packages

A

ADD_FILTER_TO_SOURCE - nl.harm27.obswebsocket.api.requests.RequestType
 
addMessage(String, Class<?>, Consumer<BaseResponse>) - Method in class nl.harm27.obswebsocket.processor.MessageReceiver
 
Authenticate - Class in nl.harm27.obswebsocket.api.requests.general
Attempt to authenticate the client to the server.
AUTHENTICATE - nl.harm27.obswebsocket.api.requests.RequestType
 
Authenticate.Request - Class in nl.harm27.obswebsocket.api.requests.general
 
Authenticate.Response - Class in nl.harm27.obswebsocket.api.requests.general
 
AUTHENTICATION_FAILED - nl.harm27.obswebsocket.authentication.AuthenticationResult
 
AUTHENTICATION_NOT_REQUIRED - nl.harm27.obswebsocket.authentication.AuthenticationResult
 
AUTHENTICATION_PASSWORD_MISSING - nl.harm27.obswebsocket.authentication.AuthenticationResult
 
AUTHENTICATION_REQUIRED - nl.harm27.obswebsocket.authentication.AuthenticationResult
 
AUTHENTICATION_REQUIRED_CHECKING - nl.harm27.obswebsocket.authentication.AuthenticationResult
 
AUTHENTICATION_SUCCESS - nl.harm27.obswebsocket.authentication.AuthenticationResult
 
AuthenticationHandler - Class in nl.harm27.obswebsocket.authentication
 
AuthenticationHandler(OBSWebSocket, String) - Constructor for class nl.harm27.obswebsocket.authentication.AuthenticationHandler
 
AuthenticationResult - Enum in nl.harm27.obswebsocket.authentication
 

B

BaseEvent - Class in nl.harm27.obswebsocket.api.events
Events are broadcast by the server to each connected client when a recognized action occurs within OBS.
BaseEvent() - Constructor for class nl.harm27.obswebsocket.api.events.BaseEvent
 
BaseRequest - Class in nl.harm27.obswebsocket.api.requests
Requests are sent by the client.
BaseRequest(RequestType, String) - Constructor for class nl.harm27.obswebsocket.api.requests.BaseRequest
 
BaseResponse - Class in nl.harm27.obswebsocket.api.requests
Response on the requests that are sent by the client.
BaseResponse() - Constructor for class nl.harm27.obswebsocket.api.requests.BaseResponse
 
BoundsType - Enum in nl.harm27.obswebsocket.api.complex
 
BROADCAST_CUSTOM_MESSAGE - nl.harm27.obswebsocket.api.events.EventType
 
BROADCAST_CUSTOM_MESSAGE - nl.harm27.obswebsocket.api.requests.RequestType
 
broadcastCustomMessage(String, Object, Consumer<BroadcastCustomMessage.Response>) - Method in class nl.harm27.obswebsocket.sender.GeneralRequestSender
Broadcast custom message to all connected WebSocket clients
broadcastCustomMessage(BroadcastCustomMessage) - Method in class nl.harm27.obswebsocket.listener.GeneralEventListener
Implement this method to process BroadcastCustomMessage events.
BroadcastCustomMessage - Class in nl.harm27.obswebsocket.api.events.general
A custom broadcast message was received
BroadcastCustomMessage - Class in nl.harm27.obswebsocket.api.requests.general
Broadcast custom message to all connected WebSocket clients
BroadcastCustomMessage() - Constructor for class nl.harm27.obswebsocket.api.events.general.BroadcastCustomMessage
 
BroadcastCustomMessage.Request - Class in nl.harm27.obswebsocket.api.requests.general
 
BroadcastCustomMessage.Response - Class in nl.harm27.obswebsocket.api.requests.general
 

C

callEvent(BaseEvent) - Method in interface nl.harm27.obswebsocket.listener.EventListener
 
callEvent(BaseEvent) - Method in class nl.harm27.obswebsocket.listener.GeneralEventListener
 
callEvent(BaseEvent) - Method in class nl.harm27.obswebsocket.listener.ScenesEventListener
 
checkAuthenticationRequired() - Method in class nl.harm27.obswebsocket.authentication.AuthenticationHandler
 
connect() - Method in class nl.harm27.obswebsocket.websocket.OBSWebSocketClient
 
connected(WebSocket) - Method in class nl.harm27.obswebsocket.OBSWebSocket
 

D

DELETE_SCENE_ITEM - nl.harm27.obswebsocket.api.requests.RequestType
 
DISABLE_STUDIO_MODE - nl.harm27.obswebsocket.api.requests.RequestType
 
DUPLICATE_SCENE_ITEM - nl.harm27.obswebsocket.api.requests.RequestType
 

E

ENABLE_STUDIO_MODE - nl.harm27.obswebsocket.api.requests.RequestType
 
ERROR - nl.harm27.obswebsocket.api.requests.Status
 
EventListener - Interface in nl.harm27.obswebsocket.listener
 
EventType - Enum in nl.harm27.obswebsocket.api.events
 
exiting(Exiting) - Method in class nl.harm27.obswebsocket.listener.GeneralEventListener
Implement this method to process Exiting events.
Exiting - Class in nl.harm27.obswebsocket.api.events.other
OBS is exiting.
Exiting() - Constructor for class nl.harm27.obswebsocket.api.events.other.Exiting
 
EXITING - nl.harm27.obswebsocket.api.events.EventType
 

F

FILTER - nl.harm27.obswebsocket.api.complex.SourceType
 

G

GeneralEventListener - Class in nl.harm27.obswebsocket.listener
The EventListener for the events that are part of the General or Other category.
GeneralEventListener() - Constructor for class nl.harm27.obswebsocket.listener.GeneralEventListener
 
GeneralRequestSender - Class in nl.harm27.obswebsocket.sender
The RequestSender for the requests that are part of the General category.
GeneralRequestSender(OBSWebSocket) - Constructor for class nl.harm27.obswebsocket.sender.GeneralRequestSender
 
GET_AUTH_REQUIRED - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_BROWSER_SOURCE_PROPERTIES - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_CURRENT_PROFILE - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_CURRENT_SCENE - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_CURRENT_SCENE_COLLECTION - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_CURRENT_TRANSITION - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_FILENAME_FORMATTING - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_MUTE - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_OUTPUT_INFO - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_PREVIEW_SCENE - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_RECORDING_FOLDER - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_SCENE_ITEM_PROPERTIES - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_SCENE_LIST - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_SOURCE_FILTER_INFO - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_SOURCE_FILTERS - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_SOURCE_SETTINGS - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_SOURCE_TYPES_LIST - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_SOURCES_LIST - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_SPECIAL_SOURCES - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_STATS - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_STREAM_SETTINGS - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_STREAMING_STATUS - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_STUDIO_MODE_STATUS - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_SYNC_OFFSET - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_TEXT_FREE_TYPE_2_PROPERTIES - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_TEXT_GDI_PLUS_PROPERTIES - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_TRANSITION_DURATION - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_TRANSITION_LIST - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_VERSION - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_VIDEO_INFO - nl.harm27.obswebsocket.api.requests.RequestType
 
GET_VOLUME - nl.harm27.obswebsocket.api.requests.RequestType
 
getAuthenticationResult() - Method in class nl.harm27.obswebsocket.authentication.AuthenticationHandler
 
getAuthenticationResult() - Method in class nl.harm27.obswebsocket.OBSWebSocket
 
GetAuthRequired - Class in nl.harm27.obswebsocket.api.requests.general
Tells the client if authentication is required.
GetAuthRequired.Request - Class in nl.harm27.obswebsocket.api.requests.general
 
GetAuthRequired.Response - Class in nl.harm27.obswebsocket.api.requests.general
 
getAvailableRequests() - Method in class nl.harm27.obswebsocket.api.requests.general.GetVersion.Response
List of available request types, formatted as a comma-separated list string (e.g.
getAverageFrameTime() - Method in class nl.harm27.obswebsocket.api.complex.OBSStats
Average frame render time (in milliseconds).
getBaseHeight() - Method in class nl.harm27.obswebsocket.api.requests.general.GetVideoInfo.Response
Base (canvas) height
getBaseWidth() - Method in class nl.harm27.obswebsocket.api.requests.general.GetVideoInfo.Response
Base (canvas) width
getBoundsAlignment() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
Alignment of the bounding box.
getBoundsType() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
Type of bounding box.
getBoundsX() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
Width of the bounding box.
getBoundsY() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
Height of the bounding box.
getChallenge() - Method in class nl.harm27.obswebsocket.api.requests.general.GetAuthRequired.Response
The required challenge to be used if authentication is required.
getClassForEvent(EventType) - Method in class nl.harm27.obswebsocket.listener.ListenerRegistry
 
getColorRange() - Method in class nl.harm27.obswebsocket.api.requests.general.GetVideoInfo.Response
Color range (full or partial)
getColorSpace() - Method in class nl.harm27.obswebsocket.api.requests.general.GetVideoInfo.Response
Color space for YUV
getCongestion() - Method in class nl.harm27.obswebsocket.api.complex.Output
Output congestion.
getCpuUsage() - Method in class nl.harm27.obswebsocket.api.complex.OBSStats
Current CPU usage (percentage).
getCropBottom() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
The number of pixels cropped off the bottom of the scene item before scaling.
getCropLeft() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
The number of pixels cropped off the left of the scene item before scaling.
getCropRight() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
The number of pixels cropped off the right of the scene item before scaling.
getCropTop() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
The number of pixels cropped off the top of the scene item before scaling.
getCurrentProfile() - Method in class nl.harm27.obswebsocket.api.events.general.Heartbeat
Current active profile.
getCurrentScene() - Method in class nl.harm27.obswebsocket.api.events.general.Heartbeat
Current active scene.
getCurrentScene() - Method in class nl.harm27.obswebsocket.api.requests.scenes.GetSceneList.Response
Name of the currently active scene.
getCurrentScene(Consumer<GetCurrentScene.Response>) - Method in class nl.harm27.obswebsocket.sender.ScenesRequestSender
Get the current scene's name and source items.
GetCurrentScene - Class in nl.harm27.obswebsocket.api.requests.scenes
Get the current scene's name and source items.
GetCurrentScene.Request - Class in nl.harm27.obswebsocket.api.requests.scenes
 
GetCurrentScene.Response - Class in nl.harm27.obswebsocket.api.requests.scenes
 
getCx() - Method in class nl.harm27.obswebsocket.api.complex.SceneItem
 
getCy() - Method in class nl.harm27.obswebsocket.api.complex.SceneItem
 
getData() - Method in class nl.harm27.obswebsocket.api.events.general.BroadcastCustomMessage
User-defined data
getDroppedFrames() - Method in class nl.harm27.obswebsocket.api.complex.Output
Number of frames dropped.
getError() - Method in class nl.harm27.obswebsocket.api.requests.BaseResponse
An error message accompanying an error status.
getEventType() - Method in class nl.harm27.obswebsocket.api.events.BaseEvent
The type of event.
getFilenameFormatting() - Method in class nl.harm27.obswebsocket.api.requests.general.GetFilenameFormatting.Response
Current filename formatting string.
getFilenameFormatting(Consumer<GetFilenameFormatting.Response>) - Method in class nl.harm27.obswebsocket.sender.GeneralRequestSender
Get the filename formatting string
GetFilenameFormatting - Class in nl.harm27.obswebsocket.api.requests.general
Get the filename formatting string
GetFilenameFormatting.Request - Class in nl.harm27.obswebsocket.api.requests.general
 
GetFilenameFormatting.Response - Class in nl.harm27.obswebsocket.api.requests.general
 
getFlags() - Method in class nl.harm27.obswebsocket.api.complex.Output
Output flags.
getFlagsRawValue() - Method in class nl.harm27.obswebsocket.api.complex.Output
Raw flags value.
getFps() - Method in class nl.harm27.obswebsocket.api.complex.OBSStats
Current framerate.
getFps() - Method in class nl.harm27.obswebsocket.api.requests.general.GetVideoInfo.Response
Frames rendered per second
getFreeDiskSpace() - Method in class nl.harm27.obswebsocket.api.complex.OBSStats
Free recording disk space (in megabytes).
getGeneralRequestSender() - Method in class nl.harm27.obswebsocket.OBSWebSocket
 
getGeneralRequestSender() - Method in class nl.harm27.obswebsocket.sender.RequestSenderManager
 
getGroupChildren() - Method in class nl.harm27.obswebsocket.api.complex.SceneItem
List of children (if this item is a group) (optional)
getGroupChildren() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
List of children (if this item is a group).
getHeight() - Method in class nl.harm27.obswebsocket.api.complex.Output
Video output height.
getHeight() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
Scene item height (base source height multiplied by the vertical scaling factor).
getId() - Method in class nl.harm27.obswebsocket.api.complex.SceneItem
Scene item ID.
getListenersForEventType(EventType) - Method in class nl.harm27.obswebsocket.listener.ListenerRegistry
 
getMemoryUsage() - Method in class nl.harm27.obswebsocket.api.complex.OBSStats
Current RAM usage (in megabytes).
getMessageId() - Method in class nl.harm27.obswebsocket.api.requests.BaseRequest
Client defined identifier for the message, will be echoed in the response.
getMessageId() - Method in class nl.harm27.obswebsocket.api.requests.BaseResponse
The client defined identifier specified in the request.
getMessageId() - Method in class nl.harm27.obswebsocket.OBSWebSocket
 
getName() - Method in class nl.harm27.obswebsocket.api.complex.Output
Output name.
getName() - Method in class nl.harm27.obswebsocket.api.complex.Scene
Name of the scene.
getName() - Method in class nl.harm27.obswebsocket.api.complex.SceneItem
The name of this Scene Item.
getName() - Method in class nl.harm27.obswebsocket.api.requests.scenes.GetCurrentScene.Response
Name of the currently active scene.
getNextMessageId() - Method in class nl.harm27.obswebsocket.sender.RequestSender
 
getObsStudioVersion() - Method in class nl.harm27.obswebsocket.api.requests.general.GetVersion.Response
OBS Studio program version.
getObsWebsocketVersion() - Method in class nl.harm27.obswebsocket.api.requests.general.GetVersion.Response
OBS Websocket plugin version.
getOutputHeight() - Method in class nl.harm27.obswebsocket.api.requests.general.GetVideoInfo.Response
Output height
getOutputSkippedFrames() - Method in class nl.harm27.obswebsocket.api.complex.OBSStats
Number of frames skipped due to encoding lag.
getOutputTotalFrames() - Method in class nl.harm27.obswebsocket.api.complex.OBSStats
Number of frames outputted.
getOutputWidth() - Method in class nl.harm27.obswebsocket.api.requests.general.GetVideoInfo.Response
Output width
getParentGroupName() - Method in class nl.harm27.obswebsocket.api.complex.SceneItem
Name of the item's parent (if this item belongs to a group) (optional)
getParentGroupName() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
Name of the item's parent (if this item belongs to a group).
getPositionAlignment() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
The point on the scene item that the item is manipulated from.
getPositionX() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
The x position of the scene item from the left.
getPositionY() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
The y position of the scene item from the top.
getPulse() - Method in class nl.harm27.obswebsocket.api.events.general.Heartbeat
Toggles between every JSON message as an "I am alive" indicator.
getRealm() - Method in class nl.harm27.obswebsocket.api.events.general.BroadcastCustomMessage
Identifier provided by the sender
getRecordingDuration() - Method in class nl.harm27.obswebsocket.api.events.BaseEvent
Time elapsed between now and recording start (only present if OBS Studio is recording) as duration.
getRecordingTimecode() - Method in class nl.harm27.obswebsocket.api.events.BaseEvent
Time elapsed between now and recording start (only present if OBS Studio is recording) as string.
getRender() - Method in class nl.harm27.obswebsocket.api.complex.SceneItem
Whether or not this Scene Item is set to "visible".
getRenderMissedFrames() - Method in class nl.harm27.obswebsocket.api.complex.OBSStats
Number of frames missed due to rendering lag.
getRenderTotalFrames() - Method in class nl.harm27.obswebsocket.api.complex.OBSStats
Number of frames rendered.
getResponseType() - Method in class nl.harm27.obswebsocket.api.requests.BaseRequest
Response type class to map the response to the correct datatype.
getResponseType() - Method in class nl.harm27.obswebsocket.api.requests.general.Authenticate.Request
 
getResponseType() - Method in class nl.harm27.obswebsocket.api.requests.general.BroadcastCustomMessage.Request
 
getResponseType() - Method in class nl.harm27.obswebsocket.api.requests.general.GetAuthRequired.Request
 
getResponseType() - Method in class nl.harm27.obswebsocket.api.requests.general.GetFilenameFormatting.Request
 
getResponseType() - Method in class nl.harm27.obswebsocket.api.requests.general.GetStats.Request
 
getResponseType() - Method in class nl.harm27.obswebsocket.api.requests.general.GetVersion.Request
 
getResponseType() - Method in class nl.harm27.obswebsocket.api.requests.general.GetVideoInfo.Request
 
getResponseType() - Method in class nl.harm27.obswebsocket.api.requests.general.OpenProjector.Request
 
getResponseType() - Method in class nl.harm27.obswebsocket.api.requests.general.SetFilenameFormatting.Request
 
getResponseType() - Method in class nl.harm27.obswebsocket.api.requests.general.SetHeartbeat.Request
 
getResponseType() - Method in class nl.harm27.obswebsocket.api.requests.scenes.GetCurrentScene.Request
 
getResponseType() - Method in class nl.harm27.obswebsocket.api.requests.scenes.GetSceneList.Request
 
getResponseType() - Method in class nl.harm27.obswebsocket.api.requests.scenes.ReorderSceneItems.Request
 
getResponseType() - Method in class nl.harm27.obswebsocket.api.requests.scenes.SetCurrentScene.Request
 
getRotation() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
The clockwise rotation of the scene item in degrees around the point of alignment.
getSalt() - Method in class nl.harm27.obswebsocket.api.requests.general.GetAuthRequired.Response
The required salt to be used if authentication is required.
getScaleType() - Method in class nl.harm27.obswebsocket.api.requests.general.GetVideoInfo.Response
Scaling method used if output size differs from base size
getScaleX() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
The x-scale factor of the scene item.
getScaleY() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
The y-scale factor of the scene item.
getSceneList(Consumer<GetSceneList.Response>) - Method in class nl.harm27.obswebsocket.sender.ScenesRequestSender
Get a list of scenes in the currently active profile.
GetSceneList - Class in nl.harm27.obswebsocket.api.requests.scenes
Get a list of scenes in the currently active profile.
GetSceneList.Request - Class in nl.harm27.obswebsocket.api.requests.scenes
 
GetSceneList.Response - Class in nl.harm27.obswebsocket.api.requests.scenes
 
getSceneName() - Method in class nl.harm27.obswebsocket.api.events.scenes.SwitchScenes
The new scene.
getScenes() - Method in class nl.harm27.obswebsocket.api.requests.scenes.GetSceneList.Response
Ordered list of the current profile's scenes (See GetCurrentScene for more information).
getScenesRequestSender() - Method in class nl.harm27.obswebsocket.OBSWebSocket
 
getScenesRequestSender() - Method in class nl.harm27.obswebsocket.sender.RequestSenderManager
 
getSettings() - Method in class nl.harm27.obswebsocket.api.complex.Output
 
getSourceCx() - Method in class nl.harm27.obswebsocket.api.complex.SceneItem
 
getSourceCy() - Method in class nl.harm27.obswebsocket.api.complex.SceneItem
 
getSourceHeight() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
Base source (without scaling) of the source.
getSources() - Method in class nl.harm27.obswebsocket.api.complex.Scene
Ordered list of the current scene's source items.
getSources() - Method in class nl.harm27.obswebsocket.api.events.scenes.SwitchScenes
List of scene items in the new scene.
getSources() - Method in class nl.harm27.obswebsocket.api.requests.scenes.GetCurrentScene.Response
Ordered list of the current scene's source items.
getSourceWidth() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
Base width (without scaling) of the source.
getStats() - Method in class nl.harm27.obswebsocket.api.events.general.Heartbeat
OBS Stats
getStats() - Method in class nl.harm27.obswebsocket.api.requests.general.GetStats.Response
OBS stats
getStats(Consumer<GetStats.Response>) - Method in class nl.harm27.obswebsocket.sender.GeneralRequestSender
Get OBS stats (almost the same info as provided in OBS' stats window)
GetStats - Class in nl.harm27.obswebsocket.api.requests.general
Get OBS stats (almost the same info as provided in OBS' stats window)
GetStats.Request - Class in nl.harm27.obswebsocket.api.requests.general
 
GetStats.Response - Class in nl.harm27.obswebsocket.api.requests.general
 
getStatus() - Method in class nl.harm27.obswebsocket.api.requests.BaseResponse
Response status, will be one of the following: ok, error
getStreamDuration() - Method in class nl.harm27.obswebsocket.api.events.BaseEvent
Time elapsed between now and stream start (only present if OBS Studio is streaming) as duration.
getStreamTimecode() - Method in class nl.harm27.obswebsocket.api.events.BaseEvent
Time elapsed between now and stream start (only present if OBS Studio is streaming) as string.
getSupportedEvents() - Method in interface nl.harm27.obswebsocket.listener.EventListener
 
getSupportedEvents() - Method in class nl.harm27.obswebsocket.listener.GeneralEventListener
 
getSupportedEvents() - Method in class nl.harm27.obswebsocket.listener.ScenesEventListener
 
getTotalBytes() - Method in class nl.harm27.obswebsocket.api.complex.Output
Total bytes sent.
getTotalFrames() - Method in class nl.harm27.obswebsocket.api.complex.Output
Number of frames sent.
getTotalRecordBytes() - Method in class nl.harm27.obswebsocket.api.events.general.Heartbeat
Total bytes recorded since the recording started.
getTotalRecordDuration() - Method in class nl.harm27.obswebsocket.api.events.general.Heartbeat
Total time (in seconds) since recording started as duration.
getTotalRecordFrames() - Method in class nl.harm27.obswebsocket.api.events.general.Heartbeat
Total frames recorded since the recording started.
getTotalRecordTime() - Method in class nl.harm27.obswebsocket.api.events.general.Heartbeat
Total time (in seconds) since recording started as int.
getTotalStreamBytes() - Method in class nl.harm27.obswebsocket.api.events.general.Heartbeat
Total bytes sent since the stream started.
getTotalStreamDuration() - Method in class nl.harm27.obswebsocket.api.events.general.Heartbeat
Total time (in seconds) since the stream started as duration.
getTotalStreamFrames() - Method in class nl.harm27.obswebsocket.api.events.general.Heartbeat
Total frames streamed since the stream started.
getTotalStreamTime() - Method in class nl.harm27.obswebsocket.api.events.general.Heartbeat
Total time (in seconds) since the stream started as int.
getType() - Method in class nl.harm27.obswebsocket.api.complex.Output
Output type/kind.
getType() - Method in class nl.harm27.obswebsocket.api.complex.SceneItem
Source type.
getVersion() - Method in class nl.harm27.obswebsocket.api.requests.general.GetVersion.Response
OBSRemote compatible API version.
getVersion(Consumer<GetVersion.Response>) - Method in class nl.harm27.obswebsocket.sender.GeneralRequestSender
Returns the latest version of the plugin and the API.
GetVersion - Class in nl.harm27.obswebsocket.api.requests.general
Returns the latest version of the plugin and the API.
GetVersion.Request - Class in nl.harm27.obswebsocket.api.requests.general
 
GetVersion.Response - Class in nl.harm27.obswebsocket.api.requests.general
 
getVideoFormat() - Method in class nl.harm27.obswebsocket.api.requests.general.GetVideoInfo.Response
Video color format
getVideoInfo(Consumer<GetVideoInfo.Response>) - Method in class nl.harm27.obswebsocket.sender.GeneralRequestSender
Get basic OBS video information
GetVideoInfo - Class in nl.harm27.obswebsocket.api.requests.general
Get basic OBS video information
GetVideoInfo.Request - Class in nl.harm27.obswebsocket.api.requests.general
 
GetVideoInfo.Response - Class in nl.harm27.obswebsocket.api.requests.general
 
getVolume() - Method in class nl.harm27.obswebsocket.api.complex.SceneItem
 
getWidth() - Method in class nl.harm27.obswebsocket.api.complex.Output
Video output width.
getWidth() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
Scene item width (base source width multiplied by the horizontal scaling factor).
getX() - Method in class nl.harm27.obswebsocket.api.complex.SceneItem
 
getY() - Method in class nl.harm27.obswebsocket.api.complex.SceneItem
 

H

heartbeat(Heartbeat) - Method in class nl.harm27.obswebsocket.listener.GeneralEventListener
Implement this method to process Heartbeat events.
Heartbeat - Class in nl.harm27.obswebsocket.api.events.general
Emitted every 2 seconds after enabling it by calling SetHeartbeat.
Heartbeat() - Constructor for class nl.harm27.obswebsocket.api.events.general.Heartbeat
 
HEARTBEAT - nl.harm27.obswebsocket.api.events.EventType
 

I

INPUT - nl.harm27.obswebsocket.api.complex.SourceType
 
isActive() - Method in class nl.harm27.obswebsocket.api.complex.Output
Output status (active or not).
isAuthRequired() - Method in class nl.harm27.obswebsocket.api.requests.general.GetAuthRequired.Response
Indicates whether authentication is required.
isConnected() - Method in class nl.harm27.obswebsocket.websocket.OBSWebSocketClient
 
isFlagsAudio() - Method in class nl.harm27.obswebsocket.api.complex.Output
Output uses audio.
isFlagsEncoded() - Method in class nl.harm27.obswebsocket.api.complex.Output
Output is encoded.
isFlagsMultiTrack() - Method in class nl.harm27.obswebsocket.api.complex.Output
Output uses several audio tracks.
isFlagsService() - Method in class nl.harm27.obswebsocket.api.complex.Output
Output uses a service.
isFlagsVideo() - Method in class nl.harm27.obswebsocket.api.complex.Output
Output uses video.
isLocked() - Method in class nl.harm27.obswebsocket.api.complex.SceneItem
Whether or not this Scene Item is locked and can't be moved around
isLocked() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
If the scene item is locked in position.
isReconnecting() - Method in class nl.harm27.obswebsocket.api.complex.Output
Output reconnection status (reconnecting or not).
isRecording() - Method in class nl.harm27.obswebsocket.api.events.general.Heartbeat
Current recording state.
isStreaming() - Method in class nl.harm27.obswebsocket.api.events.general.Heartbeat
Current streaming state.
isVisible() - Method in class nl.harm27.obswebsocket.api.complex.SceneItemTransform
If the scene item is visible.

L

LIST_OUTPUTS - nl.harm27.obswebsocket.api.requests.RequestType
 
LIST_PROFILES - nl.harm27.obswebsocket.api.requests.RequestType
 
LIST_SCENE_COLLECTIONS - nl.harm27.obswebsocket.api.requests.RequestType
 
ListenerRegistry - Class in nl.harm27.obswebsocket.listener
 
ListenerRegistry() - Constructor for class nl.harm27.obswebsocket.listener.ListenerRegistry
 

M

MessageReceiver - Class in nl.harm27.obswebsocket.processor
 
MessageReceiver(ListenerRegistry) - Constructor for class nl.harm27.obswebsocket.processor.MessageReceiver
 
MessageSender - Class in nl.harm27.obswebsocket.processor
 
MessageSender(OBSWebSocketClient) - Constructor for class nl.harm27.obswebsocket.processor.MessageSender
 
MOVE_SOURCE_FILTER - nl.harm27.obswebsocket.api.requests.RequestType
 
MULTIVIEW - nl.harm27.obswebsocket.api.requests.general.OpenProjector.Type
 

N

nl.harm27.obswebsocket - package nl.harm27.obswebsocket
 
nl.harm27.obswebsocket.api.complex - package nl.harm27.obswebsocket.api.complex
 
nl.harm27.obswebsocket.api.events - package nl.harm27.obswebsocket.api.events
 
nl.harm27.obswebsocket.api.events.general - package nl.harm27.obswebsocket.api.events.general
 
nl.harm27.obswebsocket.api.events.other - package nl.harm27.obswebsocket.api.events.other
 
nl.harm27.obswebsocket.api.events.scenes - package nl.harm27.obswebsocket.api.events.scenes
 
nl.harm27.obswebsocket.api.requests - package nl.harm27.obswebsocket.api.requests
 
nl.harm27.obswebsocket.api.requests.general - package nl.harm27.obswebsocket.api.requests.general
 
nl.harm27.obswebsocket.api.requests.scenes - package nl.harm27.obswebsocket.api.requests.scenes
 
nl.harm27.obswebsocket.authentication - package nl.harm27.obswebsocket.authentication
 
nl.harm27.obswebsocket.listener - package nl.harm27.obswebsocket.listener
 
nl.harm27.obswebsocket.processor - package nl.harm27.obswebsocket.processor
 
nl.harm27.obswebsocket.sender - package nl.harm27.obswebsocket.sender
 
nl.harm27.obswebsocket.websocket - package nl.harm27.obswebsocket.websocket
 
notifyShutdown() - Method in class nl.harm27.obswebsocket.OBSWebSocket
 
notifyShutdown() - Method in class nl.harm27.obswebsocket.websocket.OBSWebSocketClient
 
NUMERIC_FORMAT_PATTERN - Static variable in class nl.harm27.obswebsocket.OBSWebSocket
 

O

OBS_BOUNDS_MAX_ONLY - nl.harm27.obswebsocket.api.complex.BoundsType
 
OBS_BOUNDS_NONE - nl.harm27.obswebsocket.api.complex.BoundsType
 
OBS_BOUNDS_SCALE_INNER - nl.harm27.obswebsocket.api.complex.BoundsType
 
OBS_BOUNDS_SCALE_OUTER - nl.harm27.obswebsocket.api.complex.BoundsType
 
OBS_BOUNDS_SCALE_TO_HEIGHT - nl.harm27.obswebsocket.api.complex.BoundsType
 
OBS_BOUNDS_SCALE_TO_WIDTH - nl.harm27.obswebsocket.api.complex.BoundsType
 
OBS_BOUNDS_STRETCH - nl.harm27.obswebsocket.api.complex.BoundsType
 
OBSStats - Class in nl.harm27.obswebsocket.api.complex
 
OBSStats() - Constructor for class nl.harm27.obswebsocket.api.complex.OBSStats
 
OBSWebSocket - Class in nl.harm27.obswebsocket
 
OBSWebSocket(String, int) - Constructor for class nl.harm27.obswebsocket.OBSWebSocket
 
OBSWebSocket(String, int, String) - Constructor for class nl.harm27.obswebsocket.OBSWebSocket
 
OBSWebSocketClient - Class in nl.harm27.obswebsocket.websocket
 
OBSWebSocketClient(OBSWebSocket, String, int) - Constructor for class nl.harm27.obswebsocket.websocket.OBSWebSocketClient
 
OBSWebSocketListener - Class in nl.harm27.obswebsocket.websocket
 
OBSWebSocketListener(OBSWebSocket) - Constructor for class nl.harm27.obswebsocket.websocket.OBSWebSocketListener
 
OK - nl.harm27.obswebsocket.api.requests.Status
 
onClose(WebSocket, int, String) - Method in class nl.harm27.obswebsocket.websocket.OBSWebSocketListener
 
onError(WebSocket, Throwable) - Method in class nl.harm27.obswebsocket.websocket.OBSWebSocketListener
 
onOpen(WebSocket) - Method in class nl.harm27.obswebsocket.websocket.OBSWebSocketListener
 
onText(WebSocket, CharSequence, boolean) - Method in class nl.harm27.obswebsocket.websocket.OBSWebSocketListener
 
OPEN_PROJECTOR - nl.harm27.obswebsocket.api.requests.RequestType
 
openProjector(OpenProjector.Type, Integer, String, String, Consumer<OpenProjector.Response>) - Method in class nl.harm27.obswebsocket.sender.GeneralRequestSender
Open a projector window or create a projector on a monitor.
OpenProjector - Class in nl.harm27.obswebsocket.api.requests.general
Open a projector window or create a projector on a monitor.
OpenProjector.Request - Class in nl.harm27.obswebsocket.api.requests.general
 
OpenProjector.Response - Class in nl.harm27.obswebsocket.api.requests.general
 
OpenProjector.Type - Enum in nl.harm27.obswebsocket.api.requests.general
 
Output - Class in nl.harm27.obswebsocket.api.complex
 
Output() - Constructor for class nl.harm27.obswebsocket.api.complex.Output
 

P

parseDuration(String) - Method in class nl.harm27.obswebsocket.api.events.BaseEvent
 
PAUSE_RECORDING - nl.harm27.obswebsocket.api.requests.RequestType
 
PREVIEW - nl.harm27.obswebsocket.api.requests.general.OpenProjector.Type
 
PREVIEW_SCENE_CHANGED - nl.harm27.obswebsocket.api.events.EventType
 
processQueuedMessages() - Method in class nl.harm27.obswebsocket.processor.MessageSender
 
PROFILE_CHANGED - nl.harm27.obswebsocket.api.events.EventType
 
PROFILE_LIST_CHANGED - nl.harm27.obswebsocket.api.events.EventType
 

R

receiveMessage(String) - Method in class nl.harm27.obswebsocket.OBSWebSocket
 
receiveMessage(String) - Method in class nl.harm27.obswebsocket.processor.MessageReceiver
 
RECORDING_PAUSED - nl.harm27.obswebsocket.api.events.EventType
 
RECORDING_RESUMED - nl.harm27.obswebsocket.api.events.EventType
 
RECORDING_STARTED - nl.harm27.obswebsocket.api.events.EventType
 
RECORDING_STARTING - nl.harm27.obswebsocket.api.events.EventType
 
RECORDING_STOPPED - nl.harm27.obswebsocket.api.events.EventType
 
RECORDING_STOPPING - nl.harm27.obswebsocket.api.events.EventType
 
registerListener(EventListener) - Method in class nl.harm27.obswebsocket.listener.ListenerRegistry
 
registerListener(EventListener) - Method in class nl.harm27.obswebsocket.OBSWebSocket
 
REMOVE_FILTER_FROM_SOURCE - nl.harm27.obswebsocket.api.requests.RequestType
 
REORDER_SCENE_ITEMS - nl.harm27.obswebsocket.api.requests.RequestType
 
REORDER_SOURCE_FILTER - nl.harm27.obswebsocket.api.requests.RequestType
 
reorderSceneItems(String, List<SceneItem>, Consumer<ReorderSceneItems.Response>) - Method in class nl.harm27.obswebsocket.sender.ScenesRequestSender
Changes the order of scene items in the requested scene.
ReorderSceneItems - Class in nl.harm27.obswebsocket.api.requests.scenes
Changes the order of scene items in the requested scene.
ReorderSceneItems.Request - Class in nl.harm27.obswebsocket.api.requests.scenes
 
ReorderSceneItems.Response - Class in nl.harm27.obswebsocket.api.requests.scenes
 
REPLAY_STARTED - nl.harm27.obswebsocket.api.events.EventType
 
REPLAY_STARTING - nl.harm27.obswebsocket.api.events.EventType
 
REPLAY_STOPPED - nl.harm27.obswebsocket.api.events.EventType
 
REPLAY_STOPPING - nl.harm27.obswebsocket.api.events.EventType
 
Request(String) - Constructor for class nl.harm27.obswebsocket.api.requests.general.GetAuthRequired.Request
 
Request(String) - Constructor for class nl.harm27.obswebsocket.api.requests.general.GetFilenameFormatting.Request
 
Request(String) - Constructor for class nl.harm27.obswebsocket.api.requests.general.GetStats.Request
 
Request(String) - Constructor for class nl.harm27.obswebsocket.api.requests.general.GetVersion.Request
 
Request(String) - Constructor for class nl.harm27.obswebsocket.api.requests.general.GetVideoInfo.Request
 
Request(String) - Constructor for class nl.harm27.obswebsocket.api.requests.general.OpenProjector.Request
 
Request(String) - Constructor for class nl.harm27.obswebsocket.api.requests.scenes.GetCurrentScene.Request
 
Request(String) - Constructor for class nl.harm27.obswebsocket.api.requests.scenes.GetSceneList.Request
 
Request(String, boolean) - Constructor for class nl.harm27.obswebsocket.api.requests.general.SetHeartbeat.Request
 
Request(String, String) - Constructor for class nl.harm27.obswebsocket.api.requests.general.Authenticate.Request
 
Request(String, String) - Constructor for class nl.harm27.obswebsocket.api.requests.general.SetFilenameFormatting.Request
 
Request(String, String) - Constructor for class nl.harm27.obswebsocket.api.requests.scenes.SetCurrentScene.Request
 
Request(String, String, Object) - Constructor for class nl.harm27.obswebsocket.api.requests.general.BroadcastCustomMessage.Request
 
Request(String, List<SceneItem>) - Constructor for class nl.harm27.obswebsocket.api.requests.scenes.ReorderSceneItems.Request
 
RequestSender - Class in nl.harm27.obswebsocket.sender
 
RequestSender(OBSWebSocket) - Constructor for class nl.harm27.obswebsocket.sender.RequestSender
 
RequestSenderManager - Class in nl.harm27.obswebsocket.sender
 
RequestSenderManager(OBSWebSocket) - Constructor for class nl.harm27.obswebsocket.sender.RequestSenderManager
 
RequestType - Enum in nl.harm27.obswebsocket.api.requests
 
RESET_SCENE_ITEM - nl.harm27.obswebsocket.api.requests.RequestType
 
Response() - Constructor for class nl.harm27.obswebsocket.api.requests.general.Authenticate.Response
 
Response() - Constructor for class nl.harm27.obswebsocket.api.requests.general.BroadcastCustomMessage.Response
 
Response() - Constructor for class nl.harm27.obswebsocket.api.requests.general.GetAuthRequired.Response
 
Response() - Constructor for class nl.harm27.obswebsocket.api.requests.general.GetFilenameFormatting.Response
 
Response() - Constructor for class nl.harm27.obswebsocket.api.requests.general.GetStats.Response
 
Response() - Constructor for class nl.harm27.obswebsocket.api.requests.general.GetVersion.Response
 
Response() - Constructor for class nl.harm27.obswebsocket.api.requests.general.GetVideoInfo.Response
 
Response() - Constructor for class nl.harm27.obswebsocket.api.requests.general.OpenProjector.Response
 
Response() - Constructor for class nl.harm27.obswebsocket.api.requests.general.SetFilenameFormatting.Response
 
Response() - Constructor for class nl.harm27.obswebsocket.api.requests.general.SetHeartbeat.Response
 
Response() - Constructor for class nl.harm27.obswebsocket.api.requests.scenes.GetCurrentScene.Response
 
Response() - Constructor for class nl.harm27.obswebsocket.api.requests.scenes.GetSceneList.Response
 
Response() - Constructor for class nl.harm27.obswebsocket.api.requests.scenes.ReorderSceneItems.Response
 
Response() - Constructor for class nl.harm27.obswebsocket.api.requests.scenes.SetCurrentScene.Response
 
RESUME_RECORDING - nl.harm27.obswebsocket.api.requests.RequestType
 

S

SAVE_REPLAY_BUFFER - nl.harm27.obswebsocket.api.requests.RequestType
 
SAVE_STREAM_SETTINGS - nl.harm27.obswebsocket.api.requests.RequestType
 
Scene - Class in nl.harm27.obswebsocket.api.complex
 
Scene() - Constructor for class nl.harm27.obswebsocket.api.complex.Scene
 
SCENE - nl.harm27.obswebsocket.api.complex.SourceType
 
SCENE - nl.harm27.obswebsocket.api.requests.general.OpenProjector.Type
 
SCENE_COLLECTION_CHANGED - nl.harm27.obswebsocket.api.events.EventType
 
SCENE_COLLECTION_LIST_CHANGED - nl.harm27.obswebsocket.api.events.EventType
 
SCENE_ITEM_ADDED - nl.harm27.obswebsocket.api.events.EventType
 
SCENE_ITEM_DESELECTED - nl.harm27.obswebsocket.api.events.EventType
 
SCENE_ITEM_REMOVED - nl.harm27.obswebsocket.api.events.EventType
 
SCENE_ITEM_SELECTED - nl.harm27.obswebsocket.api.events.EventType
 
SCENE_ITEM_TRANSFORM_CHANGED - nl.harm27.obswebsocket.api.events.EventType
 
SCENE_ITEM_VISIBILITY_CHANGED - nl.harm27.obswebsocket.api.events.EventType
 
sceneCollectionChanged(SceneCollectionChanged) - Method in class nl.harm27.obswebsocket.listener.ScenesEventListener
Implement this method to process SceneCollectionChanged events.
SceneCollectionChanged - Class in nl.harm27.obswebsocket.api.events.scenes
Triggered when switching to another scene collection or when renaming the current scene collection.
SceneCollectionChanged() - Constructor for class nl.harm27.obswebsocket.api.events.scenes.SceneCollectionChanged
 
sceneCollectionListChanged(SceneCollectionListChanged) - Method in class nl.harm27.obswebsocket.listener.ScenesEventListener
Implement this method to process SceneCollectionListChanged events.
SceneCollectionListChanged - Class in nl.harm27.obswebsocket.api.events.scenes
Triggered when a scene collection is created, added, renamed, or removed.
SceneCollectionListChanged() - Constructor for class nl.harm27.obswebsocket.api.events.scenes.SceneCollectionListChanged
 
SceneItem - Class in nl.harm27.obswebsocket.api.complex
 
SceneItem() - Constructor for class nl.harm27.obswebsocket.api.complex.SceneItem
 
SceneItemTransform - Class in nl.harm27.obswebsocket.api.complex
 
SceneItemTransform() - Constructor for class nl.harm27.obswebsocket.api.complex.SceneItemTransform
 
SCENES_CHANGED - nl.harm27.obswebsocket.api.events.EventType
 
scenesChanged(ScenesChanged) - Method in class nl.harm27.obswebsocket.listener.ScenesEventListener
Implement this method to process ScenesChanged events.
ScenesChanged - Class in nl.harm27.obswebsocket.api.events.scenes
The scene list has been modified.
ScenesChanged() - Constructor for class nl.harm27.obswebsocket.api.events.scenes.ScenesChanged
 
ScenesEventListener - Class in nl.harm27.obswebsocket.listener
The EventListener for the events that are part of the Scenes category.
ScenesEventListener() - Constructor for class nl.harm27.obswebsocket.listener.ScenesEventListener
 
ScenesRequestSender - Class in nl.harm27.obswebsocket.sender
The RequestSender for the requests that are part of the Scenes category.
ScenesRequestSender(OBSWebSocket) - Constructor for class nl.harm27.obswebsocket.sender.ScenesRequestSender
 
SEND_CAPTIONS - nl.harm27.obswebsocket.api.requests.RequestType
 
sendMessage(BaseRequest) - Method in class nl.harm27.obswebsocket.processor.MessageSender
 
sendMessage(BaseRequest, Consumer<BaseResponse>) - Method in class nl.harm27.obswebsocket.OBSWebSocket
 
sendRequest(BaseRequest, Consumer<BaseResponse>) - Method in class nl.harm27.obswebsocket.sender.RequestSender
 
sendText(String) - Method in class nl.harm27.obswebsocket.websocket.OBSWebSocketClient
 
SET_BROWSER_SOURCE_PROPERTIES - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_CURRENT_PROFILE - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_CURRENT_SCENE - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_CURRENT_SCENE_COLLECTION - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_CURRENT_TRANSITION - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_FILENAME_FORMATTING - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_HEARTBEAT - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_MUTE - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_PREVIEW_SCENE - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_RECORDING_FOLDER - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_SCENE_ITEM_CROP - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_SCENE_ITEM_POSITION - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_SCENE_ITEM_PROPERTIES - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_SCENE_ITEM_RENDER - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_SCENE_ITEM_TRANSFORM - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_SOURCE_FILTER_SETTINGS - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_SOURCE_FILTER_VISIBILITY - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_SOURCE_SETTINGS - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_STREAM_SETTINGS - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_SYNC_OFFSET - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_TEXT_FREE_TYPE_2_PROPERTIES - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_TEXT_GDI_PLUS_PROPERTIES - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_TRANSITION_DURATION - nl.harm27.obswebsocket.api.requests.RequestType
 
SET_VOLUME - nl.harm27.obswebsocket.api.requests.RequestType
 
setCurrentScene(String, Consumer<SetCurrentScene.Response>) - Method in class nl.harm27.obswebsocket.sender.ScenesRequestSender
Switch to the specified scene.
SetCurrentScene - Class in nl.harm27.obswebsocket.api.requests.scenes
Switch to the specified scene.
SetCurrentScene.Request - Class in nl.harm27.obswebsocket.api.requests.scenes
 
SetCurrentScene.Response - Class in nl.harm27.obswebsocket.api.requests.scenes
 
setFilenameFormatting(String, Consumer<SetFilenameFormatting.Response>) - Method in class nl.harm27.obswebsocket.sender.GeneralRequestSender
Set the filename formatting string
SetFilenameFormatting - Class in nl.harm27.obswebsocket.api.requests.general
Set the filename formatting string
SetFilenameFormatting.Request - Class in nl.harm27.obswebsocket.api.requests.general
 
SetFilenameFormatting.Response - Class in nl.harm27.obswebsocket.api.requests.general
 
setGeometry(String) - Method in class nl.harm27.obswebsocket.api.requests.general.OpenProjector.Request
Size and position of the projector window (only if monitor is -1).
setHeartbeat(boolean, Consumer<SetHeartbeat.Response>) - Method in class nl.harm27.obswebsocket.sender.GeneralRequestSender
Enable/disable sending of the Heartbeat event
SetHeartbeat - Class in nl.harm27.obswebsocket.api.requests.general
Enable/disable sending of the Heartbeat event
SetHeartbeat.Request - Class in nl.harm27.obswebsocket.api.requests.general
 
SetHeartbeat.Response - Class in nl.harm27.obswebsocket.api.requests.general
 
setId(int) - Method in class nl.harm27.obswebsocket.api.complex.SceneItem
Set the scene item ID.
setMonitor(int) - Method in class nl.harm27.obswebsocket.api.requests.general.OpenProjector.Request
Monitor to open the projector on.
setName(String) - Method in class nl.harm27.obswebsocket.api.complex.SceneItem
Set the name of a scene item.
setName(String) - Method in class nl.harm27.obswebsocket.api.requests.general.OpenProjector.Request
Name of the source or scene to be displayed (ignored for other projector types).
setScene(String) - Method in class nl.harm27.obswebsocket.api.requests.scenes.ReorderSceneItems.Request
Name of the scene to reorder (defaults to current).
setType(OpenProjector.Type) - Method in class nl.harm27.obswebsocket.api.requests.general.OpenProjector.Request
Type of projector
setWebSocket(WebSocket) - Method in class nl.harm27.obswebsocket.websocket.OBSWebSocketClient
 
SOURCE - nl.harm27.obswebsocket.api.requests.general.OpenProjector.Type
 
SOURCE_AUDIO_MIXERS_CHANGED - nl.harm27.obswebsocket.api.events.EventType
 
SOURCE_AUDIO_SYNC_OFFSET_CHANGED - nl.harm27.obswebsocket.api.events.EventType
 
SOURCE_CREATED - nl.harm27.obswebsocket.api.events.EventType
 
SOURCE_DESTROYED - nl.harm27.obswebsocket.api.events.EventType
 
SOURCE_FILTER_ADDED - nl.harm27.obswebsocket.api.events.EventType
 
SOURCE_FILTER_REMOVED - nl.harm27.obswebsocket.api.events.EventType
 
SOURCE_FILTER_VISIBILITY_CHANGED - nl.harm27.obswebsocket.api.events.EventType
 
SOURCE_FILTERS_REORDERED - nl.harm27.obswebsocket.api.events.EventType
 
SOURCE_MUTE_STATE_CHANGED - nl.harm27.obswebsocket.api.events.EventType
 
SOURCE_ORDER_CHANGED - nl.harm27.obswebsocket.api.events.EventType
 
SOURCE_RENAMED - nl.harm27.obswebsocket.api.events.EventType
 
SOURCE_VOLUME_CHANGED - nl.harm27.obswebsocket.api.events.EventType
 
SourceType - Enum in nl.harm27.obswebsocket.api.complex
 
START_OUTPUT - nl.harm27.obswebsocket.api.requests.RequestType
 
START_RECORDING - nl.harm27.obswebsocket.api.requests.RequestType
 
START_REPLAY_BUFFER - nl.harm27.obswebsocket.api.requests.RequestType
 
START_STOP_RECORDING - nl.harm27.obswebsocket.api.requests.RequestType
 
START_STOP_REPLAY_BUFFER - nl.harm27.obswebsocket.api.requests.RequestType
 
START_STOP_STREAMING - nl.harm27.obswebsocket.api.requests.RequestType
 
START_STREAMING - nl.harm27.obswebsocket.api.requests.RequestType
 
Status - Enum in nl.harm27.obswebsocket.api.requests
 
STOP_OUTPUT - nl.harm27.obswebsocket.api.requests.RequestType
 
STOP_RECORDING - nl.harm27.obswebsocket.api.requests.RequestType
 
STOP_REPLAY_BUFFER - nl.harm27.obswebsocket.api.requests.RequestType
 
STOP_STREAMING - nl.harm27.obswebsocket.api.requests.RequestType
 
STREAM_STARTED - nl.harm27.obswebsocket.api.events.EventType
 
STREAM_STARTING - nl.harm27.obswebsocket.api.events.EventType
 
STREAM_STATUS - nl.harm27.obswebsocket.api.events.EventType
 
STREAM_STOPPED - nl.harm27.obswebsocket.api.events.EventType
 
STREAM_STOPPING - nl.harm27.obswebsocket.api.events.EventType
 
STUDIO_MODE_SWITCHED - nl.harm27.obswebsocket.api.events.EventType
 
STUDIO_PROGRAM - nl.harm27.obswebsocket.api.requests.general.OpenProjector.Type
 
SWITCH_SCENES - nl.harm27.obswebsocket.api.events.EventType
 
SWITCH_TRANSITION - nl.harm27.obswebsocket.api.events.EventType
 
switchScenes(SwitchScenes) - Method in class nl.harm27.obswebsocket.listener.ScenesEventListener
Implement this method to process SwitchScenes events.
SwitchScenes - Class in nl.harm27.obswebsocket.api.events.scenes
Indicates a scene change.
SwitchScenes() - Constructor for class nl.harm27.obswebsocket.api.events.scenes.SwitchScenes
 

T

TAKE_SOURCE_SCREENSHOT - nl.harm27.obswebsocket.api.requests.RequestType
 
TOGGLE_MUTE - nl.harm27.obswebsocket.api.requests.RequestType
 
TOGGLE_STUDIO_MODE - nl.harm27.obswebsocket.api.requests.RequestType
 
TRANSITION - nl.harm27.obswebsocket.api.complex.SourceType
 
TRANSITION_BEGIN - nl.harm27.obswebsocket.api.events.EventType
 
TRANSITION_DURATION_CHANGED - nl.harm27.obswebsocket.api.events.EventType
 
TRANSITION_LIST_CHANGED - nl.harm27.obswebsocket.api.events.EventType
 
TRANSITION_TO_PROGRAM - nl.harm27.obswebsocket.api.requests.RequestType
 

U

UN_AVAILABLE - nl.harm27.obswebsocket.authentication.AuthenticationResult
 
UNKNOWN - nl.harm27.obswebsocket.api.complex.SourceType
 

V

valueOf(String) - Static method in enum nl.harm27.obswebsocket.api.complex.BoundsType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum nl.harm27.obswebsocket.api.complex.SourceType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum nl.harm27.obswebsocket.api.events.EventType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum nl.harm27.obswebsocket.api.requests.general.OpenProjector.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum nl.harm27.obswebsocket.api.requests.RequestType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum nl.harm27.obswebsocket.api.requests.Status
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum nl.harm27.obswebsocket.authentication.AuthenticationResult
Returns the enum constant of this type with the specified name.
values() - Static method in enum nl.harm27.obswebsocket.api.complex.BoundsType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum nl.harm27.obswebsocket.api.complex.SourceType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum nl.harm27.obswebsocket.api.events.EventType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum nl.harm27.obswebsocket.api.requests.general.OpenProjector.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum nl.harm27.obswebsocket.api.requests.RequestType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum nl.harm27.obswebsocket.api.requests.Status
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum nl.harm27.obswebsocket.authentication.AuthenticationResult
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E F G H I L M N O P R S T U V 
All Classes All Packages