All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Class Description Authenticate Attempt to authenticate the client to the server.Authenticate.Request Authenticate.Response AuthenticationHandler AuthenticationResult BaseEvent Events are broadcast by the server to each connected client when a recognized action occurs within OBS.BaseRequest Requests are sent by the client.BaseResponse Response on the requests that are sent by the client.BoundsType BroadcastCustomMessage A custom broadcast message was receivedBroadcastCustomMessage Broadcast custom message to all connected WebSocket clientsBroadcastCustomMessage.Request BroadcastCustomMessage.Response EventListener EventType Exiting OBS is exiting.GeneralEventListener The EventListener for the events that are part of the General or Other category.GeneralRequestSender The RequestSender for the requests that are part of the General category.GetAuthRequired Tells the client if authentication is required.GetAuthRequired.Request GetAuthRequired.Response GetCurrentScene Get the current scene's name and source items.GetCurrentScene.Request GetCurrentScene.Response GetFilenameFormatting Get the filename formatting stringGetFilenameFormatting.Request GetFilenameFormatting.Response GetRecordingFolder Get the path of the current recording folder.GetRecordingFolder.Request GetRecordingFolder.Response GetSceneList Get a list of scenes in the currently active profile.GetSceneList.Request GetSceneList.Response GetStats Get OBS stats (almost the same info as provided in OBS' stats window)GetStats.Request GetStats.Response GetStreamingStatus Get current streaming and recording status.GetStreamingStatus.Request GetStreamingStatus.Response GetStreamSettings Get the current streaming server settings.GetStreamSettings.Request GetStreamSettings.Response GetVersion Returns the latest version of the plugin and the API.GetVersion.Request GetVersion.Response GetVideoInfo Get basic OBS video informationGetVideoInfo.Request GetVideoInfo.Response Heartbeat Emitted every 2 seconds after enabling it by calling SetHeartbeat.InvalidMethodException ListenerRegistry MessageReceiver MessageSender OBSStats OBSWebSocket OBSWebSocket.Builder OBSWebSocketClient OBSWebSocketListener OpenProjector Open a projector window or create a projector on a monitor.OpenProjector.Request OpenProjector.Response OpenProjector.Type Output PauseRecording Pause the current recording.PauseRecording.Request PauseRecording.Response RecordingEventListener The EventListener for the events that are part of the Recording category.RecordingPaused Current recording pausedRecordingRequestSender The RequestSender for the requests that are part of the Recording category.RecordingResumed Current recording resumedRecordingStarted Recording started successfully.RecordingStarting A request to start recording has been issued.RecordingStopped Recording stopped successfully.RecordingStopping A request to stop recording has been issued.ReorderSceneItems Changes the order of scene items in the requested scene.ReorderSceneItems.Request ReorderSceneItems.Response ReplayBufferEventListener The EventListener for the events that are part of the Replay Buffer category.ReplayBufferRequestSender The RequestSender for the requests that are part of the Replay Buffer category.ReplayStarted Replay Buffer started successfullyReplayStarting A request to start the replay buffer has been issued.ReplayStopped Replay Buffer stopped successfullyReplayStopping A request to stop the replay buffer has been issued.RequestSender RequestSenderManager RequestType ResumeRecording Resume/unpause the current recording (if paused).ResumeRecording.Request ResumeRecording.Response SaveReplayBuffer Flush and save the contents of the Replay Buffer to disk.SaveReplayBuffer.Request SaveReplayBuffer.Response SaveStreamSettings Save the current streaming server settings to disk.SaveStreamSettings.Request SaveStreamSettings.Response Scene SceneCollectionChanged Triggered when switching to another scene collection or when renaming the current scene collection.SceneCollectionListChanged Triggered when a scene collection is created, added, renamed, or removed.SceneItem SceneItemTransform ScenesChanged The scene list has been modified.ScenesEventListener The EventListener for the events that are part of the Scenes category.ScenesRequestSender The RequestSender for the requests that are part of the Scenes category.SendCaptions Send the provided text as embedded CEA-608 caption data.SendCaptions.Request SendCaptions.Response SetCurrentScene Switch to the specified scene.SetCurrentScene.Request SetCurrentScene.Response SetFilenameFormatting Set the filename formatting stringSetFilenameFormatting.Request SetFilenameFormatting.Response SetHeartbeat Enable/disable sending of the Heartbeat eventSetHeartbeat.Request SetHeartbeat.Response SetRecordingFolder Please note: if SetRecordingFolder is called while a recording is in progress, the change won't be applied immediately and will be effective on the next recording.SetRecordingFolder.Request SetRecordingFolder.Response SetStreamSettings Sets one or more attributes of the current streaming server settings.SetStreamSettings.Request SetStreamSettings.Response SourceType StartRecording Start recording.StartRecording.Request StartRecording.Response StartReplayBuffer Start recording into the Replay Buffer.StartReplayBuffer.Request StartReplayBuffer.Response StartStopRecording Toggle recording on or off.StartStopRecording.Request StartStopRecording.Response StartStopReplayBuffer Toggle the Replay Buffer on/off.StartStopReplayBuffer.Request StartStopReplayBuffer.Response StartStopStreaming Toggle streaming on or off.StartStopStreaming.Request StartStopStreaming.Response StartStreaming Start streaming.StartStreaming.Request StartStreaming.Response StartStreaming.Stream Special stream configuration.Status StopRecording Stop recording.StopRecording.Request StopRecording.Response StopReplayBuffer Stop recording into the Replay Buffer.StopReplayBuffer.Request StopReplayBuffer.Response StopStreaming Stop streaming.StopStreaming.Request StopStreaming.Response StreamingEventListener The EventListener for the events that are part of the Streaming category.StreamingRequestSender The RequestSender for the requests that are part of the Streaming category.StreamSettings Settings for the stream.StreamStarted Streaming started successfully.StreamStarting A request to start streaming has been issued.StreamStatus Emit every 2 seconds.StreamStopped Streaming stopped successfully.StreamStopping A request to stop streaming has been issued.SwitchScenes Indicates a scene change.TimeUtil