Class: OBS::WebSocket::Protocol::Responses::GetRecordingStatus

Inherits:

OBS::WebSocket::Protocol::Response

• Object
• ServerMessage
• OBS::WebSocket::Protocol::Response
• OBS::WebSocket::Protocol::Responses::GetRecordingStatus

Defined in:

lib/obs/websocket/protocol.rb

Overview

See Also:

• OBS::WebSocket::Protocol::Requests::GetRecordingStatus
• https://github.com/Palakis/obs-websocket/blob/4.9.1/docs/generated/protocol.md#getrecordingstatus

Instance Attribute Summary

• #is_recording ⇒ Boolean readonly

  isRecording field.

• #is_recording_paused ⇒ Boolean readonly

  isRecordingPaused field.

• #record_timecode ⇒ String^? readonly

  recordTimecode field.

• #recording_filename ⇒ String^? readonly

  recordingFilename field.

Method Summary

Methods inherited from OBS::WebSocket::Protocol::Response

#initialize, #to_h

Constructor Details

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

Instance Attribute Details

#is_recording ⇒ Boolean (readonly)

Returns isRecording field.

Returns:

• (Boolean) —

  isRecording field

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

def is_recording; get_field("isRecording", Types::Boolean); end

#is_recording_paused ⇒ Boolean (readonly)

Returns isRecordingPaused field.

Returns:

• (Boolean) —

  isRecordingPaused field

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

def is_recording_paused; get_field("isRecordingPaused", Types::Boolean); end

#record_timecode ⇒ String^? (readonly)

Returns recordTimecode field.

Returns:

• (String, nil) —

  recordTimecode field

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

def record_timecode; get_field("recordTimecode", Types::Optional[Types::String]); end

#recording_filename ⇒ String^? (readonly)

Returns recordingFilename field.

Returns:

• (String, nil) —

  recordingFilename field

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

def recording_filename; get_field("recordingFilename", Types::Optional[Types::String]); end