Class: OBS::WebSocket::Protocol::Events::StreamStatus

Inherits:
OBS::WebSocket::Protocol::Event show all
Defined in:
lib/obs/websocket/protocol.rb

Instance Attribute Summary collapse

Method Summary

Methods inherited from OBS::WebSocket::Protocol::Event

create, #initialize, json_name, #rec_timecode, #stream_timecode, #to_h, #update_type

Constructor Details

This class inherits a constructor from OBS::WebSocket::Protocol::Event

Instance Attribute Details

#average_frame_time ⇒ Float (readonly)

Returns average-frame-time field.

Returns:

  • (Float) —

    average-frame-time field



240
 
# File 'lib/obs/websocket/protocol.rb', line 240

def average_frame_time; get_field("average-frame-time", Types::Float); end

#bytes_per_sec ⇒ Integer (readonly)

Returns bytes-per-sec field.

Returns:

  • (Integer) —

    bytes-per-sec field



207
 
# File 'lib/obs/websocket/protocol.rb', line 207

def bytes_per_sec; get_field("bytes-per-sec", Types::Integer); end

#cpu_usage ⇒ Float (readonly)

Returns cpu-usage field.

Returns:

  • (Float) —

    cpu-usage field



243
 
# File 'lib/obs/websocket/protocol.rb', line 243

def cpu_usage; get_field("cpu-usage", Types::Float); end

#fps ⇒ Float (readonly)

Returns fps field.

Returns:

  • (Float) —

    fps field



225
 
# File 'lib/obs/websocket/protocol.rb', line 225

def fps; get_field("fps", Types::Float); end

#free_disk_space ⇒ Float (readonly)

Returns free-disk-space field.

Returns:

  • (Float) —

    free-disk-space field



249
 
# File 'lib/obs/websocket/protocol.rb', line 249

def free_disk_space; get_field("free-disk-space", Types::Float); end

#kbits_per_sec ⇒ Integer (readonly)

Returns kbits-per-sec field.

Returns:

  • (Integer) —

    kbits-per-sec field



210
 
# File 'lib/obs/websocket/protocol.rb', line 210

def kbits_per_sec; get_field("kbits-per-sec", Types::Integer); end

#memory_usage ⇒ Float (readonly)

Returns memory-usage field.

Returns:

  • (Float) —

    memory-usage field



246
 
# File 'lib/obs/websocket/protocol.rb', line 246

def memory_usage; get_field("memory-usage", Types::Float); end

#num_dropped_frames ⇒ Integer (readonly)

Returns num-dropped-frames field.

Returns:

  • (Integer) —

    num-dropped-frames field



222
 
# File 'lib/obs/websocket/protocol.rb', line 222

def num_dropped_frames; get_field("num-dropped-frames", Types::Integer); end

#num_total_frames ⇒ Integer (readonly)

Returns num-total-frames field.

Returns:

  • (Integer) —

    num-total-frames field



219
 
# File 'lib/obs/websocket/protocol.rb', line 219

def num_total_frames; get_field("num-total-frames", Types::Integer); end

#output_skipped_frames ⇒ Integer (readonly)

Returns output-skipped-frames field.

Returns:

  • (Integer) —

    output-skipped-frames field



237
 
# File 'lib/obs/websocket/protocol.rb', line 237

def output_skipped_frames; get_field("output-skipped-frames", Types::Integer); end

#output_total_frames ⇒ Integer (readonly)

Returns output-total-frames field.

Returns:

  • (Integer) —

    output-total-frames field



234
 
# File 'lib/obs/websocket/protocol.rb', line 234

def output_total_frames; get_field("output-total-frames", Types::Integer); end

#preview_only ⇒ Boolean (readonly)

Returns preview-only field.

Returns:

  • (Boolean) —

    preview-only field



252
 
# File 'lib/obs/websocket/protocol.rb', line 252

def preview_only; get_field("preview-only", Types::Boolean); end

#recording ⇒ Boolean (readonly)

Returns recording field.

Returns:

  • (Boolean) —

    recording field



201
 
# File 'lib/obs/websocket/protocol.rb', line 201

def recording; get_field("recording", Types::Boolean); end

#render_missed_frames ⇒ Integer (readonly)

Returns render-missed-frames field.

Returns:

  • (Integer) —

    render-missed-frames field



231
 
# File 'lib/obs/websocket/protocol.rb', line 231

def render_missed_frames; get_field("render-missed-frames", Types::Integer); end

#render_total_frames ⇒ Integer (readonly)

Returns render-total-frames field.

Returns:

  • (Integer) —

    render-total-frames field



228
 
# File 'lib/obs/websocket/protocol.rb', line 228

def render_total_frames; get_field("render-total-frames", Types::Integer); end

#replay_buffer_active ⇒ Boolean (readonly)

Returns replay-buffer-active field.

Returns:

  • (Boolean) —

    replay-buffer-active field



204
 
# File 'lib/obs/websocket/protocol.rb', line 204

def replay_buffer_active; get_field("replay-buffer-active", Types::Boolean); end

#strain ⇒ Float (readonly)

Returns strain field.

Returns:

  • (Float) —

    strain field



213
 
# File 'lib/obs/websocket/protocol.rb', line 213

def strain; get_field("strain", Types::Float); end

#streaming ⇒ Boolean (readonly)

Returns streaming field.

Returns:

  • (Boolean) —

    streaming field



198
 
# File 'lib/obs/websocket/protocol.rb', line 198

def streaming; get_field("streaming", Types::Boolean); end

#total_stream_time ⇒ Integer (readonly)

Returns total-stream-time field.

Returns:

  • (Integer) —

    total-stream-time field



216
 
# File 'lib/obs/websocket/protocol.rb', line 216

def total_stream_time; get_field("total-stream-time", Types::Integer); end