class
Obsctl::TUI::ObsSessionClient
- Obsctl::TUI::ObsSessionClient
- Obsctl::TUI::SessionClient
- Reference
- Object
Overview
Direct OBS adapter retained only for explicit embedded-style sessions and tests.
Defined in:
obsctl/tui/obs_session_client.crConstructors
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 methods inherited from class Obsctl::TUI::SessionClient
close : Nil
close,
connect : Nil
connect,
dump_config : Nil
dump_config,
input_names : Array(String)
input_names,
mute(target : String, muted : Bool) : Nil
mute,
next_event : OBS::Protocol::Event | Nil
next_event,
next_log : String | Nil
next_log,
next_snapshot : OBS::State::ObsSnapshot | Nil
next_snapshot,
reconnect_obs : Nil
reconnect_obs,
reload_config : Nil
reload_config,
scene_names : Array(String)
scene_names,
set_scene(target : String) : Nil
set_scene,
set_volume(target : String, percent : Int32) : Nil
set_volume,
snapshot : OBS::State::ObsSnapshot
snapshot,
toggle_mute(target : String) : Nil
toggle_mute,
validate_config : Nil
validate_config
Constructor Detail
Instance Method Detail
Closes the underlying session.
Opens the underlying session and prepares it for commands.
Requests server-side config dumping.
Returns audio input names from the current snapshot/source.
Requests a mute-state change by user target.
Returns the next pushed OBS event when available.
Returns the next pushed server log message when available.
Returns the next pushed state snapshot when available.
Requests server-owned OBS reconnection.
Requests server-side config reload.
Returns scene names from the current snapshot/source.
Requests a scene change by user target.
Requests a volume change by user target and 0-100 percent.
Returns the current full OBS snapshot.
Requests a mute toggle by user target.
Requests server-side config validation.