Class: OBS::WebSocket::Protocol::Responses::GetBrowserSourceProperties

Inherits:

OBS::WebSocket::Protocol::Response

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

Defined in:

lib/obs/websocket/protocol.rb

Overview

See Also:

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

Instance Attribute Summary

• #css ⇒ String readonly

  css field.

• #fps ⇒ Integer readonly

  fps field.

• #height ⇒ Integer readonly

  height field.

• #is_local_file ⇒ Boolean readonly

  is_local_file field.

• #local_file ⇒ String readonly

  local_file field.

• #shutdown ⇒ Boolean readonly

  shutdown field.

• #source ⇒ String readonly

  source field.

• #url ⇒ String readonly

  url field.

• #width ⇒ Integer readonly

  width 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

#css ⇒ String (readonly)

Returns css field.

Returns:

• (String) —

  css field

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

def css; get_field("css", Types::String); end

#fps ⇒ Integer (readonly)

Returns fps field.

Returns:

• (Integer) —

  fps field

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

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

#height ⇒ Integer (readonly)

Returns height field.

Returns:

• (Integer) —

  height field

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

def height; get_field("height", Types::Integer); end

#is_local_file ⇒ Boolean (readonly)

Returns is_local_file field.

Returns:

• (Boolean) —

  is_local_file field

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

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

#local_file ⇒ String (readonly)

Returns local_file field.

Returns:

• (String) —

  local_file field

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

def local_file; get_field("local_file", Types::String); end

#shutdown ⇒ Boolean (readonly)

Returns shutdown field.

Returns:

• (Boolean) —

  shutdown field

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

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

#source ⇒ String (readonly)

Returns source field.

Returns:

• (String) —

  source field

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

def source; get_field("source", Types::String); end

#url ⇒ String (readonly)

Returns url field.

Returns:

• (String) —

  url field

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

def url; get_field("url", Types::String); end

#width ⇒ Integer (readonly)

Returns width field.

Returns:

• (Integer) —

  width field

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

def width; get_field("width", Types::Integer); end