abstract class Obsctl::TUI::SessionClient

• Obsctl::TUI::SessionClient
• Reference
• Object

Overview

Boundary used by TUI sessions for state, commands, and pushed events.

Direct Known Subclasses

• Obsctl::TUI::IpcSessionClient
• Obsctl::TUI::ObsSessionClient

Defined in:

obsctl/tui/session_client.cr

Instance Method Summary

• #close : Nil

  Closes the underlying session.

• #connect : Nil

  Opens the underlying session and prepares it for commands.

• #dump_config : Nil

  Requests server-side config dumping.

• #input_names : Array(String)

  Returns audio input names from the current snapshot/source.

• #mute(target : String, muted : Bool) : Nil

  Requests a mute-state change by user target.

• #next_event : OBS::Protocol::Event | Nil

  Returns the next pushed OBS event when available.

• #next_log : String | Nil

  Returns the next pushed server log message when available.

• #next_snapshot : OBS::State::ObsSnapshot | Nil

  Returns the next pushed state snapshot when available.

• #reconnect_obs : Nil

  Requests server-owned OBS reconnection.

• #reload_config : Nil

  Requests server-side config reload.

• #scene_names : Array(String)

  Returns scene names from the current snapshot/source.

• #set_scene(target : String) : Nil

  Requests a scene change by user target.

• #set_volume(target : String, percent : Int32) : Nil

  Requests a volume change by user target and 0-100 percent.

• #snapshot : OBS::State::ObsSnapshot

  Returns the current full OBS snapshot.

• #toggle_mute(target : String) : Nil

  Requests a mute toggle by user target.

• #validate_config : Nil

  Requests server-side config validation.

Instance Method Detail