index :: proto

proto.obs

WebSocket client to control OBS studio

available since version: 0.9.8

---

methods:

• collection current get request current collection
  

• collection current set set current collection
  parameters:
  • NAME collection name
    type: symbol
    required: True
    

• collection list request collection list
  

• connect connect to OBS studio. Message [connected 1( is send to output on success, [connected 0( - on error.
  parameters:
  • [PASSWD] if specified, temporaly overrides @passwd property
    type: symbol
    

• disconnect disconnect from OBS studio. Message [connected 0( is send to output
  

• info request OBS studio information: OBS version, web-socket version, RPC version and list of supported image formats. This info is outputted as messages to first outlet.
  

• item enable enable/disable scene item
  parameters:

  • SCENE scene name
    type: symbol
    required: True
    

  • IDX item pos
    type: int
    required: True
    

  • VALUE value
    type: bool
    required: True
    

• item list request list of scene items
  parameters:
  • SCENE scene name
    type: symbol
    required: True
    
• item remove remove scene item
  parameters:

  • SCENE scene name
    type: symbol
    required: True
    

  • IDX item pos
    type: int
    required: True
    

• monitor list request monitor list
  

• scene create create new scene
  parameters:
  • SCENE scene name
    type: symbol
    required: True
    

• scene current get request current scene
  

• scene current set set current scene
  parameters:
  • SCENE scene name
    type: symbol
    required: True
    

• scene first change to first scene
  

• scene last change to last scene
  

• scene list request scene list
  

• scene next change to next scene
  

• scene prev change to prev scene
  

• scene remove remove scene
  parameters:
  • SCENE scene name
    type: symbol
    required: True
    

properties:

• @host Get/set OBS studio host name
  type: symbol
  default: localhost
  

• @passwd Get/set OBS studio password
  type: symbol
  

• @port Get/set OBS studio control port
  type: int
  range: 1..32767
  default: 4455
  

inlets:

• raw midi input bytes
  type: control

outlets:

• any messages
  type: control

keywords:

obs video

Authors: Serge Poltavsky

License: GPL3 or later