Class: OBS::WebSocket::Protocol::Responses::GetSceneItemProperties

Inherits:

OBS::WebSocket::Protocol::Response

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

Defined in:

lib/obs/websocket/protocol.rb

Overview

See Also:

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

Instance Attribute Summary

• #bounds ⇒ Hash readonly

  bounds field.

• #crop ⇒ Hash readonly

  crop field.

• #group_children ⇒ Array<SceneItemTransform>^? readonly

  groupChildren field.

• #height ⇒ Float readonly

  height field.

• #item_id ⇒ Integer readonly

  itemId field.

• #locked ⇒ Boolean readonly

  locked field.

• #muted ⇒ Boolean readonly

  muted field.

• #name ⇒ String readonly

  name field.

• #parent_group_name ⇒ String^? readonly

  parentGroupName field.

• #position ⇒ Hash readonly

  position field.

• #rotation ⇒ Float readonly

  rotation field.

• #scale ⇒ Hash readonly

  scale field.

• #source_height ⇒ Integer readonly

  sourceHeight field.

• #source_width ⇒ Integer readonly

  sourceWidth field.

• #visible ⇒ Boolean readonly

  visible field.

• #width ⇒ Float 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

#bounds ⇒ Hash (readonly)

Returns bounds field.

Returns:

• (Hash) —

  bounds field

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

def bounds; get_field("bounds", Types::Object[{:type=>{:type=>Types::String, :json_name=>"type"}, :alignment=>{:type=>Types::Integer, :json_name=>"alignment"}, :x=>{:type=>Types::Float, :json_name=>"x"}, :y=>{:type=>Types::Float, :json_name=>"y"}}]); end

#crop ⇒ Hash (readonly)

Returns crop field.

Returns:

• (Hash) —

  crop field

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

def crop; get_field("crop", Types::Object[{:top=>{:type=>Types::Integer, :json_name=>"top"}, :right=>{:type=>Types::Integer, :json_name=>"right"}, :bottom=>{:type=>Types::Integer, :json_name=>"bottom"}, :left=>{:type=>Types::Integer, :json_name=>"left"}}]); end

#group_children ⇒ Array<SceneItemTransform>^? (readonly)

Returns groupChildren field.

Returns:

• (Array<SceneItemTransform>, nil) —

  groupChildren field

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

def group_children; get_field("groupChildren", Types::Optional[Types::Array[Types::SceneItemTransform]]); end

#height ⇒ Float (readonly)

Returns height field.

Returns:

• (Float) —

  height field

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

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

#item_id ⇒ Integer (readonly)

Returns itemId field.

Returns:

• (Integer) —

  itemId field

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

def item_id; get_field("itemId", Types::Integer); end

#locked ⇒ Boolean (readonly)

Returns locked field.

Returns:

• (Boolean) —

  locked field

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

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

#muted ⇒ Boolean (readonly)

Returns muted field.

Returns:

• (Boolean) —

  muted field

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

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

#name ⇒ String (readonly)

Returns name field.

Returns:

• (String) —

  name field

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

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

#parent_group_name ⇒ String^? (readonly)

Returns parentGroupName field.

Returns:

• (String, nil) —

  parentGroupName field

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

def parent_group_name; get_field("parentGroupName", Types::Optional[Types::String]); end

#position ⇒ Hash (readonly)

Returns position field.

Returns:

• (Hash) —

  position field

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

def position; get_field("position", Types::Object[{:x=>{:type=>Types::Float, :json_name=>"x"}, :y=>{:type=>Types::Float, :json_name=>"y"}, :alignment=>{:type=>Types::Integer, :json_name=>"alignment"}}]); end

#rotation ⇒ Float (readonly)

Returns rotation field.

Returns:

• (Float) —

  rotation field

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

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

#scale ⇒ Hash (readonly)

Returns scale field.

Returns:

• (Hash) —

  scale field

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

def scale; get_field("scale", Types::Object[{:x=>{:type=>Types::Float, :json_name=>"x"}, :y=>{:type=>Types::Float, :json_name=>"y"}, :filter=>{:type=>Types::String, :json_name=>"filter"}}]); end

#source_height ⇒ Integer (readonly)

Returns sourceHeight field.

Returns:

• (Integer) —

  sourceHeight field

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

def source_height; get_field("sourceHeight", Types::Integer); end

#source_width ⇒ Integer (readonly)

Returns sourceWidth field.

Returns:

• (Integer) —

  sourceWidth field

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

def source_width; get_field("sourceWidth", Types::Integer); end

#visible ⇒ Boolean (readonly)

Returns visible field.

Returns:

• (Boolean) —

  visible field

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

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

#width ⇒ Float (readonly)

Returns width field.

Returns:

• (Float) —

  width field

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

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