Class StreamStatus
- java.lang.Object
-
- nl.harm27.obswebsocket.api.events.BaseEvent
-
- nl.harm27.obswebsocket.api.events.streaming.StreamStatus
-
public class StreamStatus extends BaseEvent
Emit every 2 seconds.- Since:
- v0.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 intgetBytesPerSec()Amount of data per second (in bytes) transmitted by the stream encoder.intgetKbitsPerSec()Amount of data per second (in kilobits) transmitted by the stream encoder.intgetNumDroppedFrames()Number of frames dropped by the encoder since the stream started.intgetNumTotalFrames()Total number of frames transmitted since the stream started.OBSStatsgetStats()Gets data from the OBSStats.doublegetStrain()Percentage of dropped frames.intgetTotalStreamTime()Total time (in seconds) since the stream started.booleanisPreviewOnly()Always false (retrocompatibility).booleanisRecording()Current recording state.booleanisReplayBufferActive()Replay Buffer statusbooleanisStreaming()Current streaming state.-
Methods inherited from class nl.harm27.obswebsocket.api.events.BaseEvent
getEventType, getRecordingDuration, getRecordingTimecode, getStreamDuration, getStreamTimecode
-
-
-
-
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.
-
getStats
public OBSStats getStats()
Gets data from the OBSStats.
-
isPreviewOnly
public boolean isPreviewOnly()
Always false (retrocompatibility).
-
-