Class: OBS::WebSocket::Protocol::Responses::GetStreamSettings

Inherits:

OBS::WebSocket::Protocol::Response

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

Defined in:

lib/obs/websocket/protocol.rb

Overview

See Also:

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

Instance Attribute Summary

• #settings ⇒ Hash readonly

  settings field.

• #type ⇒ String readonly

  type 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

#settings ⇒ Hash (readonly)

Returns settings field.

Returns:

• (Hash) —

  settings field

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

def settings; get_field("settings", Types::Object[{:server=>{:type=>Types::String, :json_name=>"server"}, :key=>{:type=>Types::String, :json_name=>"key"}, :use_auth=>{:type=>Types::Boolean, :json_name=>"use_auth"}, :username=>{:type=>Types::String, :json_name=>"username"}, :password=>{:type=>Types::String, :json_name=>"password"}}]); end

#type ⇒ String (readonly)

Returns type field.

Returns:

• (String) —

  type field

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

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