class Obsctl::TUI::ObsSessionClient

Overview

Direct OBS adapter retained only for explicit embedded-style sessions and tests.

Defined in:

obsctl/tui/obs_session_client.cr

Constructors

Instance Method Summary

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

def self.new(config : Config::Config) #

[View source]

Instance Method Detail

def close : Nil #
Description copied from class Obsctl::TUI::SessionClient

Closes the underlying session.


[View source]
def connect : Nil #
Description copied from class Obsctl::TUI::SessionClient

Opens the underlying session and prepares it for commands.


[View source]
def dump_config : Nil #
Description copied from class Obsctl::TUI::SessionClient

Requests server-side config dumping.


[View source]
def input_names : Array(String) #
Description copied from class Obsctl::TUI::SessionClient

Returns audio input names from the current snapshot/source.


[View source]
def mute(target : String, muted : Bool) : Nil #
Description copied from class Obsctl::TUI::SessionClient

Requests a mute-state change by user target.


[View source]
def next_event : OBS::Protocol::Event | Nil #
Description copied from class Obsctl::TUI::SessionClient

Returns the next pushed OBS event when available.


[View source]
def next_log : String | Nil #
Description copied from class Obsctl::TUI::SessionClient

Returns the next pushed server log message when available.


[View source]
def next_snapshot : OBS::State::ObsSnapshot | Nil #
Description copied from class Obsctl::TUI::SessionClient

Returns the next pushed state snapshot when available.


[View source]
def reconnect_obs : Nil #
Description copied from class Obsctl::TUI::SessionClient

Requests server-owned OBS reconnection.


[View source]
def reload_config : Nil #
Description copied from class Obsctl::TUI::SessionClient

Requests server-side config reload.


[View source]
def scene_names : Array(String) #
Description copied from class Obsctl::TUI::SessionClient

Returns scene names from the current snapshot/source.


[View source]
def set_scene(target : String) : Nil #
Description copied from class Obsctl::TUI::SessionClient

Requests a scene change by user target.


[View source]
def set_volume(target : String, percent : Int32) : Nil #
Description copied from class Obsctl::TUI::SessionClient

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


[View source]
def snapshot : OBS::State::ObsSnapshot #
Description copied from class Obsctl::TUI::SessionClient

Returns the current full OBS snapshot.


[View source]
def toggle_mute(target : String) : Nil #
Description copied from class Obsctl::TUI::SessionClient

Requests a mute toggle by user target.


[View source]
def validate_config : Nil #
Description copied from class Obsctl::TUI::SessionClient

Requests server-side config validation.


[View source]