Heartbeat (obs-java-client 2.0-SNAPSHOT API)

java.lang.Object
- nl.harm27.obs.websocket.api.base.BaseEvent
- - nl.harm27.obs.websocket.api.events.general.Heartbeat

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

Since:

v0.3

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.
`OBSStats`	`getStats()`	OBS Stats
`Optional<Integer>`	`getTotalRecordBytes()`	Total bytes recorded since the recording started.
`Optional<Integer>`	`getTotalRecordFrames()`	Total frames recorded since the recording started.
`Optional<Integer>`	`getTotalRecordTime()`	Total time (in seconds) since recording started.
`Optional<Integer>`	`getTotalStreamBytes()`	Total bytes sent since the stream started.
`Optional<Integer>`	`getTotalStreamFrames()`	Total frames streamed since the stream started.
`Optional<Integer>`	`getTotalStreamTime()`	Total time (in seconds) since the stream started.
`boolean`	`isPulse()`	Toggles between every JSON message as an "I am alive" indicator.
`Optional<Boolean>`	`isRecording()`	Current recording state.
`Optional<Boolean>`	`isStreaming()`	Current streaming state.

Methods inherited from class nl.harm27.obs.websocket.api.base.BaseEvent
getRecordingDuration, getRecordingTimecode, getStreamDuration, getStreamTimecode, getUpdateType

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
  - isPulse
```
public boolean isPulse()
```
    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.
  - 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.
  - 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