class Obsctl::TUI::IpcSessionClient

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

Overview

Normal TUI client that subscribes and sends commands over local IPC.

Defined in:

Constructors

• .new(client : IPC::UnixClient = IPC::UnixClient.new)

Instance Method Summary

• #close : Nil

  Closes the IPC session.

• #connect : Nil

  Connects to the local server, subscribes to state/events/logs, and starts a reader fiber for pushed messages and command responses.

• #dump_config : Nil

  Requests server-side dump-config execution.

• #input_names : Array(String)

  Returns input names from the latest server snapshot.

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

  Sends a mute or unmute command to the local server.

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

  Returns the next queued OBS event from server fanout.

• #next_log : String | Nil

  Returns the next queued server log message.

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

  Returns the latest pushed server state snapshot.

• #reconnect_obs : Nil

  Requests explicit OBS reconnection from the server.

• #reload_config : Nil

  Requests server-side config reload.

• #scene_names : Array(String)

  Returns scene names from the latest server snapshot.

• #set_scene(target : String) : Nil

  Sends a scene-change command to the local server.

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

  Sends a volume command to the local server.

• #snapshot : OBS::State::ObsSnapshot

  Returns the latest pushed snapshot, requesting one if none has arrived.

• #toggle_mute(target : String) : Nil

  Sends a toggle-mute command to the local server.

• #validate_config : Nil

  Requests server-side config validation.

Constructor Detail

Instance Method Detail