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

Class BaseEvent

java.lang.Object

nl.harm27.obs.websocket.api.base.BaseEvent

Direct Known Subclasses:

BroadcastCustomMessage, Exiting, Heartbeat, MediaEnded, MediaNext, MediaPaused, MediaPlaying, MediaPrevious, MediaRestarted, MediaStarted, MediaStopped, PreviewSceneChanged, ProfileChanged, ProfileListChanged, RecordingPaused, RecordingResumed, RecordingStarted, RecordingStarting, RecordingStopped, RecordingStopping, ReplayStarted, ReplayStarting, ReplayStopped, ReplayStopping, SceneCollectionChanged, SceneCollectionListChanged, SceneItemAdded, SceneItemDeselected, SceneItemLockChanged, SceneItemRemoved, SceneItemSelected, SceneItemTransformChanged, SceneItemVisibilityChanged, ScenesChanged, SourceAudioActivated, SourceAudioDeactivated, SourceAudioMixersChanged, SourceAudioSyncOffsetChanged, SourceCreated, SourceDestroyed, SourceFilterAdded, SourceFilterRemoved, SourceFiltersReordered, SourceFilterVisibilityChanged, SourceMuteStateChanged, SourceOrderChanged, SourceRenamed, SourceVolumeChanged, StreamStarted, StreamStarting, StreamStatus, StreamStopped, StreamStopping, StudioModeSwitched, SwitchScenes, SwitchTransition, TransitionBegin, TransitionDurationChanged, TransitionEnd, TransitionListChanged, TransitionVideoEnd, VirtualCamStarted, VirtualCamStopped

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

Modifier and Type	Method	Description
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.
EventType	getUpdateType()	Enum constants for names of the event types.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseEvent

public BaseEvent()

Method Detail

getUpdateType

public EventType getUpdateType()

Enum constants for names of the event types.

getStreamTimecode

public Optional<String> getStreamTimecode()

Time elapsed between now and stream start (only present if OBS Studio is streaming) as string.

getStreamDuration

public Optional<Duration> getStreamDuration()

Time elapsed between now and stream start (only present if OBS Studio is streaming) as duration.

getRecordingTimecode

public Optional<String> getRecordingTimecode()

Time elapsed between now and recording start (only present if OBS Studio is recording) as string.

getRecordingDuration

public Optional<Duration> getRecordingDuration()

Time elapsed between now and recording start (only present if OBS Studio is recording) as duration.