Giter Club home page Giter Club logo

cl-obs-websocket's Introduction

CL-OBS-Websocket

Low level interface to OBS Websockets

Refer to OBS protocol.

This library is not meant to be :USE'd. Use a package prefix at all times. Take advantage of local nicknames, we will be using obs: as nickname here.

Getting Started

Make sure to enable websockets in OBS! Tools>obs-websocket Settings

This library provides a low level, no frills, interface to the protocol. All protocol request names have been changed from camel case to standard lisp kebobs, e.g. "GetHotkeyList" -> get-hotkey-list. Doc strings have been pulled from the protocol. All requests that require objects, e.g. trigger-hotkey-by-key-sequence, require jsown objects or a json object string.

obs:*subscriptions* will show you all event types you can subscribe to. If no subscriptions are specified with a new client, you get subscribed to all events except high volume ones. Refer to the protool.

Clients are stored, for now, in the special obs:client and do not have to be supplied on every request. I don't really see a case for controlling multiple OBS instances at a time, feel free to change my mind.

Get a client. If you do not supply a json-parsing-fn, responses will be returned as Jsown objects. #'identity will return a json string.

(obs:new-client host port path list-of-subscriptions &optional password json-parsing-fn)

Connect your client.

(obs:connect client)

Make a request.

(obs:get-version)

Disconnect your client.

(obs:disconnect client)

cl-obs-websocket's People

Contributors

jmc-design avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.