Class BaseEvent
- java.lang.Object
-
- nl.harm27.obswebsocket.api.events.BaseEvent
-
- Direct Known Subclasses:
BroadcastCustomMessage,Exiting,Heartbeat,RecordingPaused,RecordingResumed,RecordingStarted,RecordingStarting,RecordingStopped,RecordingStopping,ReplayStarted,ReplayStarting,ReplayStopped,ReplayStopping,SceneCollectionChanged,SceneCollectionListChanged,ScenesChanged,StreamStarted,StreamStarting,StreamStatus,StreamStopped,StreamStopping,SwitchScenes
public abstract class BaseEvent extends Object
Events are broadcast by the server to each connected client when a recognized action occurs within OBS.- See Also:
- OBS WebSocket Documentation
-
-
Constructor Summary
Constructors Constructor Description BaseEvent()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EventTypegetEventType()The type of event.Optional<Duration>getRecordingDuration()Time elapsed between now and recording start (only present if OBS Studio is recording) as duration.Optional<String>getRecordingTimecode()Time elapsed between now and recording start (only present if OBS Studio is recording) as string.Optional<Duration>getStreamDuration()Time elapsed between now and stream start (only present if OBS Studio is streaming) as duration.Optional<String>getStreamTimecode()Time elapsed between now and stream start (only present if OBS Studio is streaming) as string.
-
-
-
Method Detail
-
getEventType
public EventType getEventType()
The type of event.
-
getStreamTimecode
public Optional<String> getStreamTimecode()
Time elapsed between now and stream start (only present if OBS Studio is streaming) as string.
-
getRecordingTimecode
public Optional<String> getRecordingTimecode()
Time elapsed between now and recording start (only present if OBS Studio is recording) as string.
-
getStreamDuration
public Optional<Duration> getStreamDuration()
Time elapsed between now and stream start (only present if OBS Studio is streaming) as duration.
-
-