java.lang.Object
- nl.harm27.obs.websocket.api.base.BaseEvent
- - nl.harm27.obs.websocket.api.events.streaming.StreamStatus

```
public class StreamStatus
extends BaseEvent
```
Emitted every 2 seconds when stream is active.

Since:

0.3

See Also:

OBS WebSocket Documentation

Constructor Summary

Constructors
Constructor Description

StreamStatus()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`getAverageFrameTime()`	Average frame time (in milliseconds)
`int`	`getBytesPerSec()`	Amount of data per second (in bytes) transmitted by the stream encoder.
`double`	`getCpuUsage()`	Current CPU usage (percentage)
`double`	`getFps()`	Current framerate.
`double`	`getFreeDiskSpace()`	Free recording disk space (in megabytes)
`int`	`getKbitsPerSec()`	Amount of data per second (in kilobits) transmitted by the stream encoder.
`double`	`getMemoryUsage()`	Current RAM usage (in megabytes)
`int`	`getNumDroppedFrames()`	Number of frames dropped by the encoder since the stream started.
`int`	`getNumTotalFrames()`	Total number of frames transmitted since the stream started.
`int`	`getOutputSkippedFrames()`	Number of frames skipped due to encoding lag
`int`	`getOutputTotalFrames()`	Number of frames outputted
`int`	`getRenderMissedFrames()`	Number of frames missed due to rendering lag
`int`	`getRenderTotalFrames()`	Number of frames rendered
`double`	`getStrain()`	Percentage of dropped frames.
`int`	`getTotalStreamTime()`	Total time (in seconds) since the stream started.
`boolean`	`isPreviewOnly()`	Always false (retrocompatibility).
`boolean`	`isRecording()`	Current recording state.
`boolean`	`isReplayBufferActive()`	Replay Buffer status
`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
  - StreamStatus
```
public StreamStatus()
```
- Method Detail
  - isStreaming
```
public boolean isStreaming()
```
    Current streaming state.
  - isRecording
```
public boolean isRecording()
```
    Current recording state.
  - isReplayBufferActive
```
public boolean isReplayBufferActive()
```
    Replay Buffer status
  - getBytesPerSec
```
public int getBytesPerSec()
```
    Amount of data per second (in bytes) transmitted by the stream encoder.
  - getKbitsPerSec
```
public int getKbitsPerSec()
```
    Amount of data per second (in kilobits) transmitted by the stream encoder.
  - getStrain
```
public double getStrain()
```
    Percentage of dropped frames.
  - getTotalStreamTime
```
public int getTotalStreamTime()
```
    Total time (in seconds) since the stream started.
  - getNumTotalFrames
```
public int getNumTotalFrames()
```
    Total number of frames transmitted since the stream started.
  - getNumDroppedFrames
```
public int getNumDroppedFrames()
```
    Number of frames dropped by the encoder since the stream started.
  - getFps
```
public double getFps()
```
    Current framerate.
  - getRenderTotalFrames
```
public int getRenderTotalFrames()
```
    Number of frames rendered
  - getRenderMissedFrames
```
public int getRenderMissedFrames()
```
    Number of frames missed due to rendering lag
  - getOutputTotalFrames
```
public int getOutputTotalFrames()
```
    Number of frames outputted
  - getOutputSkippedFrames
```
public int getOutputSkippedFrames()
```
    Number of frames skipped due to encoding lag
  - getAverageFrameTime
```
public double getAverageFrameTime()
```
    Average frame time (in milliseconds)
  - getCpuUsage
```
public double getCpuUsage()
```
    Current CPU usage (percentage)
  - getMemoryUsage
```
public double getMemoryUsage()
```
    Current RAM usage (in megabytes)
  - getFreeDiskSpace
```
public double getFreeDiskSpace()
```
    Free recording disk space (in megabytes)
  - isPreviewOnly
```
public boolean isPreviewOnly()
```
    Always false (retrocompatibility).

Class StreamStatus

Constructor Summary

Method Summary

Methods inherited from class nl.harm27.obs.websocket.api.base.BaseEvent

Methods inherited from class java.lang.Object

Constructor Detail

StreamStatus

Method Detail

isStreaming

isRecording

isReplayBufferActive

getBytesPerSec

getKbitsPerSec

getStrain

getTotalStreamTime

getNumTotalFrames

getNumDroppedFrames

getFps

getRenderTotalFrames

getRenderMissedFrames

getOutputTotalFrames

getOutputSkippedFrames

getAverageFrameTime

getCpuUsage

getMemoryUsage

getFreeDiskSpace

isPreviewOnly