Class: OBS::WebSocket::Protocol::Responses::GetStreamingStatus

Inherits:

OBS::WebSocket::Protocol::Response

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

Defined in:

lib/obs/websocket/protocol.rb

Overview

See Also:

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

Instance Attribute Summary

• #preview_only ⇒ Boolean readonly

  preview-only field.

• #rec_timecode ⇒ String^? readonly

  rec-timecode field.

• #recording ⇒ Boolean readonly

  recording field.

• #recording_paused ⇒ Boolean readonly

  recording-paused field.

• #stream_timecode ⇒ String^? readonly

  stream-timecode field.

• #streaming ⇒ Boolean readonly

  streaming field.

• #virtualcam ⇒ Boolean readonly

  virtualcam field.

• #virtualcam_timecode ⇒ String^? readonly

  virtualcam-timecode 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

#preview_only ⇒ Boolean (readonly)

Returns preview-only field.

Returns:

• (Boolean) —

  preview-only field

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

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

#rec_timecode ⇒ String^? (readonly)

Returns rec-timecode field.

Returns:

• (String, nil) —

  rec-timecode field

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

def rec_timecode; get_field("rec-timecode", Types::Optional[Types::String]); end

#recording ⇒ Boolean (readonly)

Returns recording field.

Returns:

• (Boolean) —

  recording field

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

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

#recording_paused ⇒ Boolean (readonly)

Returns recording-paused field.

Returns:

• (Boolean) —

  recording-paused field

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

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

#stream_timecode ⇒ String^? (readonly)

Returns stream-timecode field.

Returns:

• (String, nil) —

  stream-timecode field

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

def stream_timecode; get_field("stream-timecode", Types::Optional[Types::String]); end

#streaming ⇒ Boolean (readonly)

Returns streaming field.

Returns:

• (Boolean) —

  streaming field

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

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

#virtualcam ⇒ Boolean (readonly)

Returns virtualcam field.

Returns:

• (Boolean) —

  virtualcam field

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

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

#virtualcam_timecode ⇒ String^? (readonly)

Returns virtualcam-timecode field.

Returns:

• (String, nil) —

  virtualcam-timecode field

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

def virtualcam_timecode; get_field("virtualcam-timecode", Types::Optional[Types::String]); end