java.lang.Object
- nl.harm27.obswebsocket.api.events.BaseEvent
- - nl.harm27.obswebsocket.api.events.general.Heartbeat

```
public class Heartbeat
extends BaseEvent
```
Emitted every 2 seconds after enabling it by calling SetHeartbeat.

Since:

v4.3.0

See Also:

OBS WebSocket Documentation

Constructor Summary

Constructors
Constructor Description

Heartbeat()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Optional<String>`	`getCurrentProfile()`	Current active profile.
`Optional<String>`	`getCurrentScene()`	Current active scene.
`boolean`	`getPulse()`	Toggles between every JSON message as an "I am alive" indicator.
`OBSStats`	`getStats()`	OBS Stats
`Optional<Integer>`	`getTotalRecordBytes()`	Total bytes recorded since the recording started.
`Optional<Duration>`	`getTotalRecordDuration()`	Total time (in seconds) since recording started as duration.
`Optional<Integer>`	`getTotalRecordFrames()`	Total frames recorded since the recording started.
`Optional<Integer>`	`getTotalRecordTime()`	Total time (in seconds) since recording started as int.
`Optional<Integer>`	`getTotalStreamBytes()`	Total bytes sent since the stream started.
`Optional<Duration>`	`getTotalStreamDuration()`	Total time (in seconds) since the stream started as duration.
`Optional<Integer>`	`getTotalStreamFrames()`	Total frames streamed since the stream started.
`Optional<Integer>`	`getTotalStreamTime()`	Total time (in seconds) since the stream started as int.
`Optional<Boolean>`	`isRecording()`	Current recording state.
`Optional<Boolean>`	`isStreaming()`	Current streaming state.

Methods inherited from class nl.harm27.obswebsocket.api.events.BaseEvent
getEventType, getRecordingDuration, getRecordingTimecode, getStreamDuration, getStreamTimecode, parseDuration

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Heartbeat
```
public Heartbeat()
```
- Method Detail
  - getPulse
```
public boolean getPulse()
```
    Toggles between every JSON message as an "I am alive" indicator.
  - getCurrentProfile
```
public Optional<String> getCurrentProfile()
```
    Current active profile.
  - getCurrentScene
```
public Optional<String> getCurrentScene()
```
    Current active scene.
  - isStreaming
```
public Optional<Boolean> isStreaming()
```
    Current streaming state.
  - getTotalStreamTime
```
public Optional<Integer> getTotalStreamTime()
```
    Total time (in seconds) since the stream started as int.
  - getTotalStreamDuration
```
public Optional<Duration> getTotalStreamDuration()
```
    Total time (in seconds) since the stream started as duration.
  - getTotalStreamBytes
```
public Optional<Integer> getTotalStreamBytes()
```
    Total bytes sent since the stream started.
  - getTotalStreamFrames
```
public Optional<Integer> getTotalStreamFrames()
```
    Total frames streamed since the stream started.
  - isRecording
```
public Optional<Boolean> isRecording()
```
    Current recording state.
  - getTotalRecordTime
```
public Optional<Integer> getTotalRecordTime()
```
    Total time (in seconds) since recording started as int.
  - getTotalRecordDuration
```
public Optional<Duration> getTotalRecordDuration()
```
    Total time (in seconds) since recording started as duration.
  - getTotalRecordBytes
```
public Optional<Integer> getTotalRecordBytes()
```
    Total bytes recorded since the recording started.
  - getTotalRecordFrames
```
public Optional<Integer> getTotalRecordFrames()
```
    Total frames recorded since the recording started.
  - getStats
```
public OBSStats getStats()
```
    OBS Stats

Class Heartbeat

Constructor Summary

Method Summary

Methods inherited from class nl.harm27.obswebsocket.api.events.BaseEvent

Methods inherited from class java.lang.Object

Constructor Detail

Heartbeat

Method Detail

getPulse

getCurrentProfile

getCurrentScene

isStreaming

getTotalStreamTime

getTotalStreamDuration

getTotalStreamBytes

getTotalStreamFrames

isRecording

getTotalRecordTime

getTotalRecordDuration

getTotalRecordBytes

getTotalRecordFrames

getStats