OBS Remote Terminal

OBS RT is a plugin for OBS Stúdio that allows user to control basic functions through any terminal using telnet.

Commands

• scene <action> [<args>...] - execute a scene action

  • list - list available scenes
  • set <scene index> - select scene by index.
  • switch - switch to scene in preview screen

• streaming <action> [<args>...] - handle streaming

  • start - start streaming service
  • stop - stop streaming service
  • status - print streaming service status <active|inactive>
  • info - print streaming service type and settings
  • config <attribute_name> <attribute_value> - update a streaming service configuration

• recording <action> [<args>...] - handle streaming

  • start - start recording
  • stop - stop recording
  • status - print recording status <active|inactive>

• audio <action> [<args>...] - handle audio devices

  • list - list audio devices
  • mute <device index> - mute audio device by index
  • unmute <device index> - unmute audio device by index

• window <action> [<args>...] - handle OBS main window

  • geometry [<x> <y> <width> <height>] - get/set OBS main window geometry
  • show [<mode>] - show OBS main window. Modes: normal|maximized|fullscreen
  • hide - hide OBS main window