Class: OBS::WebSocket::Protocol::Events::Heartbeat

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

#current_profile ⇒ String? (readonly)

Returns current-profile field.

Returns:

  • (String, nil) —

    current-profile field



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

def current_profile; get_field("current-profile", Types::Optional[Types::String]); end

#current_scene ⇒ String? (readonly)

Returns current-scene field.

Returns:

  • (String, nil) —

    current-scene field



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

def current_scene; get_field("current-scene", Types::Optional[Types::String]); end

#pulse ⇒ Boolean (readonly)

Returns pulse field.

Returns:

  • (Boolean) —

    pulse field



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

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

#recording ⇒ Boolean? (readonly)

Returns recording field.

Returns:

  • (Boolean, nil) —

    recording field



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

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

#stats ⇒ OBSStats (readonly)

Returns stats field.

Returns:

  • (OBSStats) —

    stats field



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

def stats; get_field("stats", Types::OBSStats); end

#streaming ⇒ Boolean? (readonly)

Returns streaming field.

Returns:

  • (Boolean, nil) —

    streaming field



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

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

#total_record_bytes ⇒ Integer? (readonly)

Returns total-record-bytes field.

Returns:

  • (Integer, nil) —

    total-record-bytes field



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

def total_record_bytes; get_field("total-record-bytes", Types::Optional[Types::Integer]); end

#total_record_frames ⇒ Integer? (readonly)

Returns total-record-frames field.

Returns:

  • (Integer, nil) —

    total-record-frames field



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

def total_record_frames; get_field("total-record-frames", Types::Optional[Types::Integer]); end

#total_record_time ⇒ Integer? (readonly)

Returns total-record-time field.

Returns:

  • (Integer, nil) —

    total-record-time field



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

def total_record_time; get_field("total-record-time", Types::Optional[Types::Integer]); end

#total_stream_bytes ⇒ Integer? (readonly)

Returns total-stream-bytes field.

Returns:

  • (Integer, nil) —

    total-stream-bytes field



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

def total_stream_bytes; get_field("total-stream-bytes", Types::Optional[Types::Integer]); end

#total_stream_frames ⇒ Integer? (readonly)

Returns total-stream-frames field.

Returns:

  • (Integer, nil) —

    total-stream-frames field



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

def total_stream_frames; get_field("total-stream-frames", Types::Optional[Types::Integer]); end

#total_stream_time ⇒ Integer? (readonly)

Returns total-stream-time field.

Returns:

  • (Integer, nil) —

    total-stream-time field



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

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